fix(publisher): treat GitHub device-flow slow_down as retriable (#1290)

## Summary

- Handle GitHub's OAuth device-flow `slow_down` response per [RFC 8628
§3.5](https://datatracker.ietf.org/doc/html/rfc8628#section-3.5) — treat
it as retriable and bump the polling interval by 5 seconds, instead of
bailing with a fatal error.

Fixes #1289.

## Why

`pollForToken` in `cmd/publisher/auth/github-at.go` only treats
`authorization_pending` as retriable. Every other response from GitHub's
token endpoint — including the non-terminal `slow_down` signal — falls
through to:

```go
return "", fmt.Errorf("token request failed: %s", tokenResp.Error)
```

So users hitting GitHub's polling rate-limit get:

```
Error: login failed: error polling for token: token request failed: slow_down
```

…and have to re-run `mcp-publisher login github` from scratch, which is
especially painful because `slow_down` is more likely when the user
takes more than a few seconds to enter and authorize the device code.

Per RFC 8628 §3.5, `slow_down` is defined as:

> A variant of "authorization_pending", the authorization request is
still pending and polling should continue, but the interval MUST be
increased by 5 seconds for this and all subsequent requests.

## Change

Treat `slow_down` the same as `authorization_pending` but increase
`interval` by 5 seconds before sleeping, matching the RFC exactly.

A possible follow-up (not in this PR, to keep the diff minimal): seed
the initial `interval` from `DeviceCodeResponse.Interval` (already
parsed but currently unused) instead of hardcoding `5`. Happy to do that
here or as a separate PR if preferred.

## Test plan

- [x] `go build ./cmd/publisher/...` — clean
- [x] `go test ./cmd/publisher/auth/...` — passes
- [x] `gofmt -d` and `go vet ./cmd/publisher/auth/...` — clean
- [ ] CI `make check` (lint + integration tests)

I could not exercise `pollForToken` from a unit test without refactoring
`GitHubAccessTokenURL` to be injectable, which felt out of scope for a
bug-fix PR. Glad to add that refactor + a table-driven test for
`authorization_pending` / `slow_down` / fatal errors in a follow-up if
maintainers want it.

---------

Co-authored-by: developer-ishan <igupta@groupon.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Ishan Gupta 2026-09-16 20:44:51 +05:30 • committed by GitHub
commit 73aebc1526
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 170 additions and 7 deletions

View file

@ -17,6 +17,17 @@ const (
GitHubAccessTokenURL = "https://github.com/login/oauth/access_token" // #nosec:G101 GitHubAccessTokenURL = "https://github.com/login/oauth/access_token" // #nosec:G101
) )
const (
// defaultPollInterval is the initial device-flow polling interval in
// seconds, per RFC 8628 §3.5.
defaultPollInterval = 5
// maxPollInterval caps how large the polling interval may grow. RFC 8628
// §3.5 mandates a 5-second increase on each slow_down but leaves the
// maximum to the implementation; this prevents a misbehaving auth server
// from growing the interval unboundedly.
maxPollInterval = 60
)
// DeviceCodeResponse represents the response from GitHub's device code endpoint // DeviceCodeResponse represents the response from GitHub's device code endpoint
type DeviceCodeResponse struct { type DeviceCodeResponse struct {
DeviceCode string `json:"device_code"` DeviceCode string `json:"device_code"`
@ -46,6 +57,16 @@ type GitHubATProvider struct {
registryURL string registryURL string
providedToken string // Token provided via --token flag or MCP_GITHUB_TOKEN env var providedToken string // Token provided via --token flag or MCP_GITHUB_TOKEN env var
githubToken string // In-memory GitHub token set by Login() githubToken string // In-memory GitHub token set by Login()
// accessTokenURL is the GitHub access-token polling endpoint. It is a field
// (rather than the package constant) so tests can point it at a mock server.
accessTokenURL string
// pollInterval is the initial polling interval in seconds. Defaults to
// defaultPollInterval; overridable in tests to avoid real delays.
pollInterval int
// sleep abstracts time.Sleep so tests can run without real delays and
// assert the back-off sequence. Defaults to time.Sleep.
sleep func(time.Duration)
} }
// ServerHealthResponse represents the response from the health endpoint // ServerHealthResponse represents the response from the health endpoint
@ -62,8 +83,11 @@ func NewGitHubATProvider(registryURL, token string) Provider {
} }
return &GitHubATProvider{ return &GitHubATProvider{
registryURL: registryURL, registryURL: registryURL,
providedToken: token, providedToken: token,
accessTokenURL: GitHubAccessTokenURL,
pollInterval: defaultPollInterval,
sleep: time.Sleep,
} }
} }
@ -199,12 +223,12 @@ func (g *GitHubATProvider) pollForToken(ctx context.Context, deviceCode string)
} }
// Default polling interval and expiration time // Default polling interval and expiration time
interval := 5 // seconds interval := g.pollInterval
expiresIn := 900 // 15 minutes expiresIn := 900 // 15 minutes
deadline := time.Now().Add(time.Duration(expiresIn) * time.Second) deadline := time.Now().Add(time.Duration(expiresIn) * time.Second)
for time.Now().Before(deadline) { for time.Now().Before(deadline) {
req, err := http.NewRequestWithContext(ctx, http.MethodPost, GitHubAccessTokenURL, bytes.NewBuffer(jsonData)) req, err := http.NewRequestWithContext(ctx, http.MethodPost, g.accessTokenURL, bytes.NewBuffer(jsonData))
if err != nil { if err != nil {
return "", err return "", err
} }
@ -229,9 +253,17 @@ func (g *GitHubATProvider) pollForToken(ctx context.Context, deviceCode string)
return "", err return "", err
} }
if tokenResp.Error == "authorization_pending" { // Per RFC 8628 §3.5, both authorization_pending and slow_down indicate
// User hasn't authorized yet, wait and retry // the client should keep polling. slow_down additionally requires that
time.Sleep(time.Duration(interval) * time.Second) // the polling interval be increased by 5 seconds.
if tokenResp.Error == "authorization_pending" || tokenResp.Error == "slow_down" {
if tokenResp.Error == "slow_down" {
interval += 5
if interval > maxPollInterval {
interval = maxPollInterval
}
}
g.sleep(time.Duration(interval) * time.Second)
continue continue
} }

View file

@ -0,0 +1,131 @@
package auth
import (
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// newMockTokenServer returns an httptest.Server that serves the given sequence
// of AccessTokenResponse values, one per request. Once the sequence is
// exhausted the final response is reused for any extra requests.
func newMockTokenServer(t *testing.T, responses []AccessTokenResponse) *httptest.Server {
t.Helper()
var i int
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
resp := responses[len(responses)-1]
if i < len(responses) {
resp = responses[i]
}
i++
w.Header().Set("Content-Type", "application/json")
_ = json.NewEncoder(w).Encode(resp) // #nosec G117 -- test fixture token, not a real secret
}))
t.Cleanup(srv.Close)
return srv
}
// newPollTestProvider builds a provider wired to a mock token endpoint. The
// initial poll interval is 0 (so the back-off starts from a known base) and
// sleeps are captured rather than performed, making the tests deterministic and
// instant. The returned slice records every interval passed to sleep.
func newPollTestProvider(tokenURL string) (*GitHubATProvider, *[]time.Duration) {
slept := &[]time.Duration{}
p := &GitHubATProvider{
clientID: "test-client-id",
accessTokenURL: tokenURL,
pollInterval: 0,
sleep: func(d time.Duration) { *slept = append(*slept, d) },
}
return p, slept
}
// TestPollForToken_SlowDownThenSuccess confirms that a slow_down response is
// treated as retriable: polling continues and the success path is reached.
func TestPollForToken_SlowDownThenSuccess(t *testing.T) {
srv := newMockTokenServer(t, []AccessTokenResponse{
{Error: "slow_down"},
{AccessToken: "gh-token"},
})
p, slept := newPollTestProvider(srv.URL)
token, err := p.pollForToken(context.Background(), "device-code")
require.NoError(t, err)
assert.Equal(t, "gh-token", token)
// One slow_down => one back-off, interval bumped 0 -> 5.
require.Len(t, *slept, 1)
assert.Equal(t, 5*time.Second, (*slept)[0])
}
// TestPollForToken_MixedRetryableErrorsCompoundInterval confirms the interval
// increment compounds correctly across mixed retryable errors. Per RFC 8628
// §3.5 the interval is increased by 5 seconds on each slow_down and is NOT
// reset between slow_down instances, while authorization_pending leaves it
// unchanged.
func TestPollForToken_MixedRetryableErrorsCompoundInterval(t *testing.T) {
srv := newMockTokenServer(t, []AccessTokenResponse{
{Error: "slow_down"}, // 0 -> 5
{Error: "authorization_pending"}, // stays 5
{Error: "slow_down"}, // 5 -> 10
{AccessToken: "gh-token"},
})
p, slept := newPollTestProvider(srv.URL)
token, err := p.pollForToken(context.Background(), "device-code")
require.NoError(t, err)
assert.Equal(t, "gh-token", token)
require.Len(t, *slept, 3)
assert.Equal(t, 5*time.Second, (*slept)[0]) // after first slow_down
assert.Equal(t, 5*time.Second, (*slept)[1]) // authorization_pending: unchanged
assert.Equal(t, 10*time.Second, (*slept)[2]) // second slow_down: compounded
}
// TestPollForToken_IntervalCappedAtMax confirms the polling interval is capped
// so a misbehaving auth server returning slow_down repeatedly cannot grow it
// without bound.
func TestPollForToken_IntervalCappedAtMax(t *testing.T) {
// 13 slow_downs starting from interval 0 would otherwise reach 65s
// (5, 10, ..., 60, 65); the cap holds it at 60.
responses := make([]AccessTokenResponse, 0, 14)
for range [13]struct{}{} {
responses = append(responses, AccessTokenResponse{Error: "slow_down"})
}
responses = append(responses, AccessTokenResponse{AccessToken: "gh-token"})
srv := newMockTokenServer(t, responses)
p, slept := newPollTestProvider(srv.URL)
token, err := p.pollForToken(context.Background(), "device-code")
require.NoError(t, err)
assert.Equal(t, "gh-token", token)
require.Len(t, *slept, 13)
for _, d := range *slept {
assert.LessOrEqual(t, d, time.Duration(maxPollInterval)*time.Second)
}
// The last two back-offs are both pinned at the cap.
assert.Equal(t, time.Duration(maxPollInterval)*time.Second, (*slept)[11])
assert.Equal(t, time.Duration(maxPollInterval)*time.Second, (*slept)[12])
}
// TestPollForToken_FatalErrorStopsPolling confirms a non-retryable error ends
// polling immediately with an error.
func TestPollForToken_FatalErrorStopsPolling(t *testing.T) {
srv := newMockTokenServer(t, []AccessTokenResponse{
{Error: "access_denied"},
})
p, slept := newPollTestProvider(srv.URL)
_, err := p.pollForToken(context.Background(), "device-code")
require.Error(t, err)
assert.Contains(t, err.Error(), "access_denied")
assert.Empty(t, *slept, "fatal error should not trigger a back-off sleep")
}