mirror of
https://github.com/runkids/skillshare.git
synced 2026-11-20 12:23:22 +00:00
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
85 lines
2.3 KiB
Go
85 lines
2.3 KiB
Go
package install
|
|
|
|
import (
|
|
"os"
|
|
"os/exec"
|
|
"path/filepath"
|
|
"testing"
|
|
)
|
|
|
|
func TestSupportsSparseCheckoutVersion(t *testing.T) {
|
|
tests := []struct {
|
|
version string
|
|
want bool
|
|
}{
|
|
{version: "git version 2.24.9", want: false},
|
|
{version: "git version 2.25.0", want: true},
|
|
{version: "git version 2.39.3 (Apple Git-146)", want: true},
|
|
{version: "git version 3.0.0", want: true},
|
|
{version: "invalid", want: false},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
got := supportsSparseCheckoutVersion(tt.version)
|
|
if got != tt.want {
|
|
t.Fatalf("supportsSparseCheckoutVersion(%q) = %v, want %v", tt.version, got, tt.want)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestSparseCloneSubdir_FileURL(t *testing.T) {
|
|
if _, err := exec.LookPath("git"); err != nil {
|
|
t.Skip("git not available")
|
|
}
|
|
if !gitSupportsSparseCheckout() {
|
|
t.Skip("git does not support sparse-checkout")
|
|
}
|
|
|
|
tmp := t.TempDir()
|
|
work := filepath.Join(tmp, "work")
|
|
remote := filepath.Join(tmp, "remote.git")
|
|
dest := filepath.Join(tmp, "clone")
|
|
|
|
mustRunGit(t, "", "init", work)
|
|
mustRunGit(t, work, "config", "user.email", "test@test.com")
|
|
mustRunGit(t, work, "config", "user.name", "Test")
|
|
|
|
if err := os.MkdirAll(filepath.Join(work, "skills", "one"), 0755); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if err := os.MkdirAll(filepath.Join(work, "other"), 0755); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if err := os.WriteFile(filepath.Join(work, "skills", "one", "SKILL.md"), []byte("# one"), 0644); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if err := os.WriteFile(filepath.Join(work, "other", "README.md"), []byte("other"), 0644); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
mustRunGit(t, work, "add", ".")
|
|
mustRunGit(t, work, "commit", "-m", "init")
|
|
mustRunGit(t, "", "clone", "--bare", work, remote)
|
|
|
|
if err := sparseCloneSubdir("file://"+remote, "skills/one", dest, nil, nil); err != nil {
|
|
t.Fatalf("sparseCloneSubdir() error = %v", err)
|
|
}
|
|
|
|
if _, err := os.Stat(filepath.Join(dest, "skills", "one", "SKILL.md")); err != nil {
|
|
t.Fatalf("expected sparse path file to exist: %v", err)
|
|
}
|
|
if _, err := os.Stat(filepath.Join(dest, "other", "README.md")); err == nil {
|
|
t.Fatalf("expected non-sparse path to be absent")
|
|
}
|
|
}
|
|
|
|
func mustRunGit(t *testing.T, dir string, args ...string) {
|
|
t.Helper()
|
|
cmd := exec.Command("git", args...)
|
|
cmd.Dir = dir
|
|
out, err := cmd.CombinedOutput()
|
|
if err != nil {
|
|
t.Fatalf("git %v failed: %v\n%s", args, err, out)
|
|
}
|
|
}
|