Files
skillshare/internal/github/client.go
T
Willie b014f8c6dc feat: optimize large-repo install and update flows
Implement Issue #46 across install/update paths to reduce perceived hangs and improve subdir installation performance on large repositories.

Main changes:
- Add git progress streaming primitives in internal/install/git_progress.go.
  - runGitCommandWithProgress supports stderr streaming callbacks in TTY mode.
  - scanGitProgress handles both CR and LF progress delimiters.
- Thread InstallOptions.OnProgress through clone/pull/discovery/install/update paths.
  - Keep non-TTY behavior quiet to avoid noisy logs.
  - Add TreeSpinner.Update for live message updates.
- Add progress-aware git update APIs in internal/git/info.go:
  - PullWithProgress and ForcePullWithProgress (keep PullWithEnv/ForcePullWithEnv for compatibility).
- Introduce shared GitHub client utilities in internal/github/client.go.
  - Centralize token lookup, request construction, and rate-limit handling.
  - Refactor internal/search/search.go to use shared client while preserving compatibility aliases.
- Add GitHub/GHE API subdir fast path in internal/install/github_download.go.
  - github.com => api.github.com
  - github-like enterprise hosts => https://<host>/api/v3
  - On API failure, emit warning and fallback to git-based flows.
- Add sparse checkout fallback for non-GitHub subdir sources in internal/install/sparse_checkout.go.
  - Use filter+no-checkout+depth=1 then sparse-checkout set + checkout.
- Extend discovery/install metadata plumbing.
  - DiscoveryResult now includes CommitHash and Warnings.
  - install/discover subdir paths preserve warnings and commit hashes from API/sparse/full-clone flows.
- Preserve compatibility and UX expectations.
  - Keep existing action strings (for tests/UI stability).
  - Keep legacy discover/pull APIs as wrappers around new progress-aware variants.
- Improve --track download efficiency.
  - Track clone now attempts --filter=blob:none --depth 1 --single-branch first.
  - Falls back to full clone only on remote capability mismatch, not on auth/not-found errors.

CLI wiring:
- cmd/skillshare/install.go
  - TTY handlers now pass progress callbacks and use with-progress discover APIs.
  - Subdir handler shows API-vs-clone stage messages and renders discovery fallback warnings.
- cmd/skillshare/update.go and cmd/skillshare/update_project.go
  - Use PullWithProgress/ForcePullWithProgress for tracked repos.
  - Ensure reinstall/update install flows forward progress callbacks.

Tests added/updated:
- internal/install/git_progress_test.go
- internal/install/github_download_test.go
- internal/install/sparse_checkout_test.go
- internal/install/tracked_clone_test.go
- internal/install/source_test.go (GitHubOwner/GitHubRepo coverage)
- internal/git/info_test.go (PullWithProgress/ForcePullWithProgress)
- tests/integration/install_subdir_optimization_test.go
- tests/integration/install_online_test.go (GitHub API subdir case)

Validation performed:
- go test ./internal/install -count=1
- go test ./internal/git -run 'Test.*Pull.*' -count=1
- go build -o bin/skillshare ./cmd/skillshare && SKILLSHARE_TEST_BINARY="/Users/williehung/Developer/Apps/github/skillshare/bin/skillshare" go test ./tests/integration -run 'TestInstall_Subdir|TestUpdate_' -count=1
- go build -o bin/skillshare ./cmd/skillshare && SKILLSHARE_TEST_BINARY="/Users/williehung/Developer/Apps/github/skillshare/bin/skillshare" go test ./tests/integration -run 'TestInstall_Track_|TestUpdate_TrackedRepo' -count=1
- go test -tags online ./tests/integration -run TestInstall_GitHubSubdirViaAPI -count=1
- make lint
- make test
2026-02-25 07:02:54 +08:00

89 lines
2.0 KiB
Go

package github
import (
"fmt"
"net/http"
"os"
"os/exec"
"strings"
"sync"
"time"
)
// RateLimitError indicates GitHub API rate limit was exceeded.
type RateLimitError struct {
Limit string
Remaining string
Reset string
}
func (e *RateLimitError) Error() string {
msg := "GitHub API rate limit exceeded"
if e.Remaining == "0" {
msg += fmt.Sprintf(" (0/%s remaining)", e.Limit)
}
return msg
}
// NewClient creates an HTTP client for GitHub/GHE APIs.
func NewClient() *http.Client {
return &http.Client{Timeout: 15 * time.Second}
}
// NewRequest creates a GET request with default GitHub headers and optional
// token auth (GITHUB_TOKEN / GH_TOKEN / gh auth token).
func NewRequest(url string) (*http.Request, error) {
req, err := http.NewRequest(http.MethodGet, url, nil)
if err != nil {
return nil, err
}
req.Header.Set("Accept", "application/vnd.github.v3+json")
if token := GetToken(); token != "" {
req.Header.Set("Authorization", "token "+token)
}
return req, nil
}
var (
tokenOnce sync.Once
cachedToken string
)
// GetToken returns an auth token from environment variables first, then from
// `gh auth token` (cached with sync.Once).
func GetToken() string {
if token := os.Getenv("GITHUB_TOKEN"); token != "" {
return token
}
if token := os.Getenv("GH_TOKEN"); token != "" {
return token
}
tokenOnce.Do(func() {
cmd := exec.Command("gh", "auth", "token")
out, err := cmd.Output()
if err != nil {
return
}
cachedToken = strings.TrimSpace(string(out))
})
return cachedToken
}
// CheckRateLimit checks response status and returns a rate-limit typed error
// when the API has throttled the caller.
func CheckRateLimit(resp *http.Response) error {
if resp.StatusCode == http.StatusForbidden || resp.StatusCode == http.StatusTooManyRequests {
return &RateLimitError{
Limit: resp.Header.Get("X-RateLimit-Limit"),
Remaining: resp.Header.Get("X-RateLimit-Remaining"),
Reset: resp.Header.Get("X-RateLimit-Reset"),
}
}
return nil
}