mirror of
https://github.com/runkids/skillshare.git
synced 2026-11-19 02:17:09 +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
113 lines
3.1 KiB
Go
113 lines
3.1 KiB
Go
//go:build !online
|
|
|
|
package integration
|
|
|
|
import (
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
"skillshare/internal/install"
|
|
"skillshare/internal/testutil"
|
|
)
|
|
|
|
func TestInstall_SubdirFromFileURL(t *testing.T) {
|
|
sb := testutil.NewSandbox(t)
|
|
defer sb.Cleanup()
|
|
|
|
sb.WriteConfig(`source: ` + sb.SourcePath + `
|
|
targets: {}
|
|
`)
|
|
|
|
repoPath := filepath.Join(sb.Root, "subdir-repo")
|
|
sb.WriteFile(filepath.Join(repoPath, "skills", "alpha", "SKILL.md"), "# alpha")
|
|
sb.WriteFile(filepath.Join(repoPath, "skills", "alpha", "README.md"), "alpha readme")
|
|
sb.WriteFile(filepath.Join(repoPath, "other", "ignored.txt"), "ignore me")
|
|
initGitRepo(t, repoPath)
|
|
|
|
source := &install.Source{
|
|
Type: install.SourceTypeGitHTTPS,
|
|
Raw: "file://" + repoPath + "/skills/alpha",
|
|
CloneURL: "file://" + repoPath,
|
|
Subdir: "skills/alpha",
|
|
Name: "alpha",
|
|
}
|
|
|
|
destPath := filepath.Join(sb.SourcePath, "alpha")
|
|
result, err := install.Install(source, destPath, install.InstallOptions{})
|
|
if err != nil {
|
|
t.Fatalf("Install() error = %v", err)
|
|
}
|
|
if result.Action != "cloned and extracted" {
|
|
t.Fatalf("Action = %q, want %q", result.Action, "cloned and extracted")
|
|
}
|
|
|
|
if !sb.FileExists(filepath.Join(destPath, "SKILL.md")) {
|
|
t.Fatal("expected SKILL.md to be installed")
|
|
}
|
|
if sb.FileExists(filepath.Join(destPath, "ignored.txt")) {
|
|
t.Fatal("unexpected non-subdir file copied into destination")
|
|
}
|
|
}
|
|
|
|
func TestInstall_SubdirFallback_FuzzyPath(t *testing.T) {
|
|
sb := testutil.NewSandbox(t)
|
|
defer sb.Cleanup()
|
|
|
|
sb.WriteConfig(`source: ` + sb.SourcePath + `
|
|
targets: {}
|
|
`)
|
|
|
|
repoPath := filepath.Join(sb.Root, "fuzzy-subdir-repo")
|
|
sb.WriteFile(filepath.Join(repoPath, "skills", "pdf", "SKILL.md"), "# PDF")
|
|
initGitRepo(t, repoPath)
|
|
|
|
source := &install.Source{
|
|
Type: install.SourceTypeGitHTTPS,
|
|
Raw: "file://" + repoPath + "/pdf",
|
|
CloneURL: "file://" + repoPath,
|
|
Subdir: "pdf", // fuzzy match should resolve to skills/pdf on full-clone fallback
|
|
Name: "pdf",
|
|
}
|
|
|
|
destPath := filepath.Join(sb.SourcePath, "pdf")
|
|
result, err := install.Install(source, destPath, install.InstallOptions{})
|
|
if err != nil {
|
|
t.Fatalf("Install() error = %v", err)
|
|
}
|
|
if result.Action != "cloned and extracted" {
|
|
t.Fatalf("Action = %q, want %q", result.Action, "cloned and extracted")
|
|
}
|
|
if !sb.FileExists(filepath.Join(destPath, "SKILL.md")) {
|
|
t.Fatal("expected fuzzy subdir install to succeed")
|
|
}
|
|
}
|
|
|
|
func TestInstall_NonTTY_NoRawGitProgress(t *testing.T) {
|
|
sb := testutil.NewSandbox(t)
|
|
defer sb.Cleanup()
|
|
|
|
sb.WriteConfig(`source: ` + sb.SourcePath + `
|
|
targets: {}
|
|
`)
|
|
|
|
repoPath := filepath.Join(sb.Root, "progress-repo")
|
|
sb.WriteFile(filepath.Join(repoPath, "skill-a", "SKILL.md"), "# skill-a")
|
|
initGitRepo(t, repoPath)
|
|
|
|
installResult := sb.RunCLI("install", "file://"+repoPath, "--track", "--name", "progress-track")
|
|
installResult.AssertSuccess(t)
|
|
|
|
output := installResult.Output()
|
|
rawProgressHints := []string{
|
|
"Receiving objects:",
|
|
"Resolving deltas:",
|
|
"remote:",
|
|
}
|
|
for _, hint := range rawProgressHints {
|
|
if strings.Contains(output, hint) {
|
|
t.Fatalf("expected non-TTY install output to stay quiet; found %q in output", hint)
|
|
}
|
|
}
|
|
}
|