From 36113be45e28eb4f8767715da88b944ea17cd348 Mon Sep 17 00:00:00 2001 From: Willie Date: Thu, 8 Oct 2026 16:00:37 +0800 Subject: [PATCH] fix(extras): prune a symlink target only when it links to the source The CLI's `--remove-target --prune` removed a symlink-mode target no matter where it pointed, while the dashboard removed it only when it still linked to the extra's source folder. A user who repointed that link at their own folder could lose it from the CLI. Both now go through one shared sync.ClearExtraTarget, so the safer rule applies everywhere; the CLI warns and leaves anything that is not a link to the source instead of failing. Refs #491 --- cmd/skillshare/extras_remove_target.go | 22 +++---- internal/server/handler_extras_edit.go | 43 +------------ internal/sync/extras.go | 42 ++++++++++++ tests/integration/extras_target_test.go | 64 ++++++++++++++++--- website/docs/reference/commands/extras.md | 2 +- .../current/reference/commands/extras.md | 2 +- .../current/reference/commands/extras.md | 2 +- .../current/reference/commands/extras.md | 2 +- .../current/reference/commands/extras.md | 2 +- 9 files changed, 113 insertions(+), 68 deletions(-) diff --git a/cmd/skillshare/extras_remove_target.go b/cmd/skillshare/extras_remove_target.go index bbfa5eb11..1dd288e8f 100644 --- a/cmd/skillshare/extras_remove_target.go +++ b/cmd/skillshare/extras_remove_target.go @@ -134,26 +134,20 @@ func cmdExtrasRemoveTarget(args []string) error { resolved := canonicalExtraTargetPath(mode, cwd, target.Path) var pruned int - if prune && extras[idx].File != "" { - changed, restoreErr := sync.RestoreExtraTarget(sync.NewExtraFile(sourceDirForExtra(extras[idx]), extras[idx].File, resolved, target.As, targetMode)) - if restoreErr != nil { - return fmt.Errorf("failed to prune target %s: %w", shortenPath(rmPath), restoreErr) - } - if changed { - pruned = 1 - } - } else if prune { + var kept bool + if prune { + sourceDir := sourceDirForExtra(extras[idx]) var managedFiles map[string]bool - if targetMode == "copy" { + if extras[idx].File == "" && targetMode == "copy" { var managedErr error - managedFiles, managedErr = managedExtraTargetFiles(target, sourceDirForExtra(extras[idx]), extensionsDir) + managedFiles, managedErr = managedExtraTargetFiles(target, sourceDir, extensionsDir) if managedErr != nil { return managedErr } } var errs []string - pruned, errs = sync.PruneExtraTargetFiles(resolved, sourceDirForExtra(extras[idx]), targetMode, managedFiles) + pruned, kept, errs = sync.ClearExtraTarget(extras[idx].File, sourceDir, resolved, target.As, targetMode, managedFiles) if len(errs) > 0 { for _, msg := range errs { ui.Warning("%s", msg) @@ -174,7 +168,9 @@ func cmdExtrasRemoveTarget(args []string) error { ui.Done(ui.MarkOK, fmt.Sprintf("Removed target %s from %s", shortenPath(rmPath), name), 0) - if prune { + if kept { + ui.Warning("%s is not a link to %s's source; left in place", shortenPath(rmPath), name) + } else if prune { ui.Note(fmt.Sprintf("Pruned %s from %s", plural(pruned, "file"), shortenPath(rmPath))) } else if extras[idx].File != "" { ui.Note("Target file left in place and no longer managed. Sync will not remove it.") diff --git a/internal/server/handler_extras_edit.go b/internal/server/handler_extras_edit.go index 5bb434244..90331d50d 100644 --- a/internal/server/handler_extras_edit.go +++ b/internal/server/handler_extras_edit.go @@ -138,7 +138,7 @@ func (s *Server) handleExtrasEditTarget(w http.ResponseWriter, r *http.Request) sourceDir := s.extrasSourceDir(extra) oldMode := syncpkg.ExtraTargetMode(old.Mode, extra.File != "") var errs []string - resp["pruned"], errs = clearExtraTarget(extra.File, sourceDir, oldPath, old.As, oldMode) + resp["pruned"], _, errs = syncpkg.ClearExtraTarget(extra.File, sourceDir, oldPath, old.As, oldMode, nil) results := s.syncExtras(name, false, false) resp["extras"] = results if len(errs) > 0 { @@ -265,7 +265,7 @@ func (s *Server) handleExtrasEdit(w http.ResponseWriter, r *http.Request) { if relink { for _, t := range extra.Targets { mode := syncpkg.ExtraTargetMode(t.Mode, extra.File != "") - _, errs := clearExtraTarget(extra.File, oldSource, resolveExtrasTargetPath(s.projectRoot, t.Path), t.As, mode) + _, _, errs := syncpkg.ClearExtraTarget(extra.File, oldSource, resolveExtrasTargetPath(s.projectRoot, t.Path), t.As, mode, nil) pruneErrs = append(pruneErrs, errs...) } } @@ -288,27 +288,6 @@ func (s *Server) handleExtrasEdit(w http.ResponseWriter, r *http.Request) { writeJSON(w, resp) } -// clearExtraTarget removes what skillshare put at one target: links into -// sourceDir in merge mode, the folder link in symlink mode, and a single-file -// target goes back to how it was. Copies stay, since nothing records which -// copied files are skillshare's. -func clearExtraTarget(file, sourceDir, targetPath, as, mode string) (int, []string) { - if file != "" { - changed, err := syncpkg.RestoreExtraTarget(syncpkg.NewExtraFile(sourceDir, file, targetPath, as, mode)) - if err != nil { - return 0, []string{err.Error()} - } - if changed { - return 1, nil - } - return 0, nil - } - if mode == "symlink" && !linksTo(targetPath, sourceDir) { - return 0, nil - } - return syncpkg.PruneExtraTargetFiles(targetPath, sourceDir, mode, nil) -} - // storedExtraSource is dir as an extra's source field: absolute in global // mode, relative to the project root in project mode. func (s *Server) storedExtraSource(dir string) (string, error) { @@ -330,21 +309,3 @@ func (s *Server) validateExtra(name string) error { } return s.cfg.ValidateExtras(name) } - -// linksTo reports whether link is a symlink to dir, comparing the link text -// too, so a link whose folder has since moved or been deleted still counts. -func linksTo(link, dir string) bool { - dest, err := os.Readlink(link) - if err != nil { - return false - } - if !filepath.IsAbs(dest) { - dest = filepath.Join(filepath.Dir(link), dest) - } - if filepath.Clean(dest) == filepath.Clean(dir) { - return true - } - real, err := filepath.EvalSymlinks(link) - src, srcErr := filepath.EvalSymlinks(dir) - return err == nil && srcErr == nil && real == src -} diff --git a/internal/sync/extras.go b/internal/sync/extras.go index 5efc813eb..2a4029328 100644 --- a/internal/sync/extras.go +++ b/internal/sync/extras.go @@ -600,6 +600,48 @@ func PruneExtraTargetFiles(targetPath, sourcePath, mode string, managedFiles map } } +// ClearExtraTarget removes what skillshare put at one target: a single-file +// target goes back to how it was, links into sourceDir go in merge mode, the +// managedFiles go in copy mode, and in symlink mode the target goes only when +// it is a link to sourceDir. kept reports a symlink-mode target left in place +// because it is something else. +func ClearExtraTarget(file, sourceDir, targetPath, as, mode string, managedFiles map[string]bool) (pruned int, kept bool, errors []string) { + if file != "" { + changed, err := RestoreExtraTarget(NewExtraFile(sourceDir, file, targetPath, as, mode)) + if err != nil { + return 0, false, []string{err.Error()} + } + if changed { + return 1, false, nil + } + return 0, false, nil + } + if mode == "symlink" && !LinksTo(targetPath, sourceDir) { + _, err := os.Lstat(targetPath) + return 0, err == nil, nil + } + pruned, errors = PruneExtraTargetFiles(targetPath, sourceDir, mode, managedFiles) + return pruned, false, errors +} + +// LinksTo reports whether link is a symlink to dir, comparing the link text +// too, so a link whose folder has since moved or been deleted still counts. +func LinksTo(link, dir string) bool { + dest, err := os.Readlink(link) + if err != nil { + return false + } + if !filepath.IsAbs(dest) { + dest = filepath.Join(filepath.Dir(link), dest) + } + if filepath.Clean(dest) == filepath.Clean(dir) { + return true + } + real, err := filepath.EvalSymlinks(link) + src, srcErr := filepath.EvalSymlinks(dir) + return err == nil && srcErr == nil && real == src +} + func pruneExtraManagedFiles(targetPath string, managedFiles map[string]bool) (pruned int, errors []string) { if len(managedFiles) == 0 { return 0, nil diff --git a/tests/integration/extras_target_test.go b/tests/integration/extras_target_test.go index 596ce4f53..279e1bc14 100644 --- a/tests/integration/extras_target_test.go +++ b/tests/integration/extras_target_test.go @@ -213,7 +213,7 @@ extras: } } -func TestExtrasTarget_RemoveTargetPrune_SymlinkTargetRealDirFailsAndKeepsConfig(t *testing.T) { +func TestExtrasTarget_RemoveTargetPrune_SymlinkTargetRealDirIsKept(t *testing.T) { sb := testutil.NewSandbox(t) defer sb.Cleanup() @@ -238,19 +238,65 @@ extras: `) result := sb.RunCLI("extras", "rules", "--remove-target", dir1, "--prune", "-g") - result.AssertFailure(t) - result.AssertAnyOutputContains(t, "target is not a symlink") + result.AssertSuccess(t) + result.AssertAnyOutputContains(t, "left in place") if _, err := os.Stat(filepath.Join(dir1, "local.md")); err != nil { - t.Fatalf("local file must be preserved after failed prune, stat err = %v", err) + t.Fatalf("local file must be preserved, stat err = %v", err) + } + if strings.Contains(sb.ReadFile(sb.ConfigPath), dir1) { + t.Errorf("config should no longer contain removed target %s", dir1) + } +} + +// --prune removes a symlink target only when it still links to the extra's +// source; a link the user pointed elsewhere stays. +func TestExtrasTarget_RemoveTargetPrune_SymlinkOnlyWhenLinkedToSource(t *testing.T) { + sb := testutil.NewSandbox(t) + defer sb.Cleanup() + + srcDir := filepath.Join(sb.Home, ".config", "skillshare", "extras", "rules") + sb.WriteFile(filepath.Join(srcDir, "managed.md"), "managed\n") + elsewhere := filepath.Join(sb.Home, "elsewhere") + if err := os.MkdirAll(elsewhere, 0755); err != nil { + t.Fatal(err) } - configContent := sb.ReadFile(sb.ConfigPath) - if !strings.Contains(configContent, dir1) { - t.Errorf("config should still contain failed target %s:\n%s", dir1, configContent) + ours := filepath.Join(sb.Home, "target-ours") + theirs := filepath.Join(sb.Home, "target-theirs") + keep := filepath.Join(sb.Home, "target-keep") + if err := os.Symlink(srcDir, ours); err != nil { + t.Fatal(err) } - if !strings.Contains(configContent, dir2) { - t.Errorf("config should still contain remaining target %s:\n%s", dir2, configContent) + if err := os.Symlink(elsewhere, theirs); err != nil { + t.Fatal(err) + } + if err := os.MkdirAll(keep, 0755); err != nil { + t.Fatal(err) + } + + sb.WriteConfig(`source: ` + sb.SourcePath + ` +extras: + - name: rules + targets: + - path: ` + ours + ` + mode: symlink + - path: ` + theirs + ` + mode: symlink + - path: ` + keep + ` + mode: copy +`) + + sb.RunCLI("extras", "rules", "--remove-target", ours, "--prune", "-g").AssertSuccess(t) + if _, err := os.Lstat(ours); !os.IsNotExist(err) { + t.Fatalf("symlink to the source should be removed, lstat err = %v", err) + } + + result := sb.RunCLI("extras", "rules", "--remove-target", theirs, "--prune", "-g") + result.AssertSuccess(t) + result.AssertAnyOutputContains(t, "left in place") + if dest, err := os.Readlink(theirs); err != nil || dest != elsewhere { + t.Fatalf("symlink pointing elsewhere must stay, readlink = %q, %v", dest, err) } } diff --git a/website/docs/reference/commands/extras.md b/website/docs/reference/commands/extras.md index 466c01946..0cf15d051 100644 --- a/website/docs/reference/commands/extras.md +++ b/website/docs/reference/commands/extras.md @@ -291,7 +291,7 @@ skillshare extras --help | `--add-target ` | Add a new target to the extra | | `--as ` | Target filename for `--add-target` (single-file extras only; defaults to `file`) | | `--remove-target ` | Remove a target from the extra (config-only by default) | -| `--prune` | With `--remove-target`: also delete skillshare-managed files under that target. For a single-file extra it restores the target file instead | +| `--prune` | With `--remove-target`: also delete skillshare-managed files under that target. For a single-file extra it restores the target file instead. A `symlink` target is removed only when it still links to the extra's source | | `--target ` | Target directory path (required for `--mode` and filter flags with multi-target extras; `--flatten`/`--no-flatten` applies to all targets when omitted) | | `--project, -p` | Use project-mode extras (`.skillshare/`) | | `--global, -g` | Use global extras (`~/.config/skillshare/`) | diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/reference/commands/extras.md b/website/i18n/ja/docusaurus-plugin-content-docs/current/reference/commands/extras.md index fda61902e..47c51b675 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current/reference/commands/extras.md +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current/reference/commands/extras.md @@ -222,7 +222,7 @@ skillshare extras --help | `--add-target ` | Extras に新しい Target を追加 | | `--as ` | `--add-target` の Target ファイル名(単一ファイルの Extras のみ。既定値は `file`) | | `--remove-target ` | Extras から Target を削除(デフォルトでは設定のみ) | -| `--prune` | `--remove-target` と併用: その Target 配下の skillshare 管理ファイルも削除。単一ファイルの Extras では、代わりに Target のファイルを元に戻す | +| `--prune` | `--remove-target` と併用: その Target 配下の skillshare 管理ファイルも削除。単一ファイルの Extras では、代わりに Target のファイルを元に戻す。`symlink` の Target は Extras のソースへのリンクのときだけ削除 | | `--target ` | Target ディレクトリのパス(複数 Target を持つ Extras で `--mode` やフィルターのフラグを使う場合は必須。省略時、`--flatten`/`--no-flatten` はすべての Target に適用される) | | `--project, -p` | Project モードの Extras(`.skillshare/`)を使用 | | `--global, -g` | グローバルの Extras(`~/.config/skillshare/`)を使用 | diff --git a/website/i18n/ko/docusaurus-plugin-content-docs/current/reference/commands/extras.md b/website/i18n/ko/docusaurus-plugin-content-docs/current/reference/commands/extras.md index 3f274139c..a7309a778 100644 --- a/website/i18n/ko/docusaurus-plugin-content-docs/current/reference/commands/extras.md +++ b/website/i18n/ko/docusaurus-plugin-content-docs/current/reference/commands/extras.md @@ -222,7 +222,7 @@ skillshare extras --help | `--add-target ` | extra에 새 target 추가 | | `--as ` | `--add-target`의 target 파일 이름 (single-file extra 전용, 기본값은 `file`) | | `--remove-target ` | extra에서 target 제거 (기본적으로 config 전용) | -| `--prune` | `--remove-target`과 함께: 해당 target 아래의 skillshare 관리 파일도 삭제. single-file extra에서는 대신 target 파일을 복원 | +| `--prune` | `--remove-target`과 함께: 해당 target 아래의 skillshare 관리 파일도 삭제. single-file extra에서는 대신 target 파일을 복원. `symlink` target은 extra의 소스를 가리키는 링크일 때만 삭제 | | `--target ` | target 디렉터리 경로 (multi-target extra에서 `--mode`나 필터 플래그에 필요; 생략 시 `--flatten`/`--no-flatten`은 모든 target에 적용) | | `--project, -p` | 프로젝트 모드 extras 사용 (`.skillshare/`) | | `--global, -g` | 전역 extras 사용 (`~/.config/skillshare/`) | diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference/commands/extras.md b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference/commands/extras.md index d088b1c9b..6835a9836 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference/commands/extras.md +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference/commands/extras.md @@ -222,7 +222,7 @@ skillshare extras --help | `--add-target ` | 为该 extra 添加一个新 target | | `--as ` | `--add-target` 的 target 文件名(仅限单文件 extra;默认为 `file`) | | `--remove-target ` | 从该 extra 中移除一个 target(默认仅修改配置) | -| `--prune` | 与 `--remove-target` 一起使用:同时删除该 target 下由 skillshare 管理的文件。对单文件 extra 则改为还原 target 文件 | +| `--prune` | 与 `--remove-target` 一起使用:同时删除该 target 下由 skillshare 管理的文件。对单文件 extra 则改为还原 target 文件。`symlink` target 仅在仍链接到该 extra 的来源时才会删除 | | `--target ` | Target 目录路径(对多 target 的 extra 使用 `--mode` 或筛选标志时必填;省略时 `--flatten`/`--no-flatten` 会应用于所有 target) | | `--project, -p` | 使用 project-mode extras(`.skillshare/`) | | `--global, -g` | 使用 global extras(`~/.config/skillshare/`) | diff --git a/website/i18n/zh-Hant/docusaurus-plugin-content-docs/current/reference/commands/extras.md b/website/i18n/zh-Hant/docusaurus-plugin-content-docs/current/reference/commands/extras.md index 92e4bd6e6..84da1794a 100644 --- a/website/i18n/zh-Hant/docusaurus-plugin-content-docs/current/reference/commands/extras.md +++ b/website/i18n/zh-Hant/docusaurus-plugin-content-docs/current/reference/commands/extras.md @@ -222,7 +222,7 @@ skillshare extras --help | `--add-target ` | 為此 extra 新增一個 target | | `--as ` | `--add-target` 的 target 檔名(僅限單一檔案 extra;預設為 `file`) | | `--remove-target ` | 從此 extra 移除一個 target(預設僅變更設定) | -| `--prune` | 搭配 `--remove-target` 使用:同時刪除該 target 底下由 skillshare 管理的檔案。若是單一檔案 extra,則會改為還原 target 檔案 | +| `--prune` | 搭配 `--remove-target` 使用:同時刪除該 target 底下由 skillshare 管理的檔案。若是單一檔案 extra,則會改為還原 target 檔案。`symlink` target 只有仍連結到該 extra 的來源時才會刪除 | | `--target ` | Target 目錄路徑(多 target 的 extra 使用 `--mode` 或篩選旗標時為必填;省略時 `--flatten`/`--no-flatten` 會套用到所有 target) | | `--project, -p` | 使用 project mode 的 extras(`.skillshare/`) | | `--global, -g` | 使用 global 的 extras(`~/.config/skillshare/`) |