Generated Wiki Stale Purge Method (#5)

Reviewed-on: https://gitea.westgate.pw/ShadowsOverWestgate/sow-tools/pulls/5 Co-authored-by: vickydotbat <vickydotbat@tutamail.com> Co-committed-by: vickydotbat <vickydotbat@tutamail.com>
2026-05-21 14:58:51 +02:00
parent a64dbfb085
commit f57a3c6ff2
7 changed files with 342 additions and 12 deletions
@@ -842,6 +842,233 @@ func TestDeployWikiReportsAndArchivesStalePages(t *testing.T) {
 	}
 }

+func TestDeployWikiDryRunPlansTrackedStalePagePurge(t *testing.T) {
+	root := t.TempDir()
+	sourceDir := filepath.Join(root, "pages")
+	if err := os.MkdirAll(filepath.Join(sourceDir, "skills"), 0755); err != nil {
+		t.Fatalf("create source dir: %v", err)
+	}
+	manifestPath := filepath.Join(root, "deploy-manifest.json")
+	if err := saveDeployManifest(manifestPath, wikiDeployManifest{
+		Version: "nodebb-v1",
+		Pages: map[string]wikiDeployManifestPage{
+			"skills:retired": {Hash: "old-hash", Title: "Retired Skill", Namespace: "skills", TID: 7, PID: 42, CID: 3},
+		},
+	}); err != nil {
+		t.Fatalf("write deploy manifest: %v", err)
+	}
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		t.Fatalf("dry-run purge must not call NodeBB, got %s %s", r.Method, r.URL.Path)
+	}))
+	defer server.Close()
+
+	result, err := DeployWikiWithOptions(&project.Project{}, DeployWikiOptions{
+		SourceDir:    sourceDir,
+		Endpoint:     server.URL,
+		Token:        "nodebb-token",
+		ManifestPath: manifestPath,
+		DryRun:       true,
+		StalePolicy:  "purge",
+	}, nil)
+	if err != nil {
+		t.Fatalf("DeployWikiWithOptions stale purge dry run failed: %v", err)
+	}
+	if result.Stale != 1 || result.Purged != 1 {
+		t.Fatalf("expected one planned stale purge, got %#v", result)
+	}
+	if _, ok := loadDeployManifest(manifestPath).Pages["skills:retired"]; !ok {
+		t.Fatalf("dry-run purge must not change the deploy manifest")
+	}
+}
+
+func TestDeployWikiPurgeRefusesStaleManifestEntryWithoutTopicID(t *testing.T) {
+	root := t.TempDir()
+	sourceDir := filepath.Join(root, "pages")
+	if err := os.MkdirAll(filepath.Join(sourceDir, "skills"), 0755); err != nil {
+		t.Fatalf("create source dir: %v", err)
+	}
+	manifestPath := filepath.Join(root, "deploy-manifest.json")
+	if err := saveDeployManifest(manifestPath, wikiDeployManifest{
+		Version: "nodebb-v1",
+		Pages: map[string]wikiDeployManifestPage{
+			"skills:retired": {Hash: "old-hash", Title: "Retired Skill", Namespace: "skills", PID: 42, CID: 3},
+		},
+	}); err != nil {
+		t.Fatalf("write deploy manifest: %v", err)
+	}
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		t.Fatalf("missing-topic-id purge must not call NodeBB, got %s %s", r.Method, r.URL.Path)
+	}))
+	defer server.Close()
+
+	_, err := DeployWikiWithOptions(&project.Project{}, DeployWikiOptions{
+		SourceDir:    sourceDir,
+		Endpoint:     server.URL,
+		Token:        "nodebb-token",
+		ManifestPath: manifestPath,
+		DryRun:       true,
+		StalePolicy:  "purge",
+	}, nil)
+	if err == nil || !strings.Contains(err.Error(), "topic id") {
+		t.Fatalf("expected stale purge to require tracked topic id, got %v", err)
+	}
+}
+
+func TestDeployWikiPurgesTrackedStaleGeneratedTopic(t *testing.T) {
+	root := t.TempDir()
+	sourceDir := filepath.Join(root, "pages")
+	if err := os.MkdirAll(filepath.Join(sourceDir, "skills"), 0755); err != nil {
+		t.Fatalf("create source dir: %v", err)
+	}
+	manifestPath := filepath.Join(root, "deploy-manifest.json")
+	if err := saveDeployManifest(manifestPath, wikiDeployManifest{
+		Version: "nodebb-v1",
+		Pages: map[string]wikiDeployManifestPage{
+			"skills:retired": {Hash: "old-hash", Title: "Retired Skill", Namespace: "skills", TID: 7, PID: 42, CID: 3},
+		},
+	}); err != nil {
+		t.Fatalf("write deploy manifest: %v", err)
+	}
+	purgeCalls := 0
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if r.Method != http.MethodDelete || r.URL.Path != "/api/v3/topics/7" {
+			t.Fatalf("unexpected request %s %s", r.Method, r.URL.Path)
+		}
+		purgeCalls++
+		w.Header().Set("Content-Type", "application/json")
+		_ = json.NewEncoder(w).Encode(map[string]any{"status": map[string]any{"code": "ok"}})
+	}))
+	defer server.Close()
+
+	result, err := DeployWikiWithOptions(&project.Project{}, DeployWikiOptions{
+		SourceDir:    sourceDir,
+		Endpoint:     server.URL,
+		Token:        "nodebb-token",
+		ManifestPath: manifestPath,
+		StalePolicy:  "purge",
+	}, nil)
+	if err != nil {
+		t.Fatalf("DeployWikiWithOptions stale purge failed: %v", err)
+	}
+	if result.Stale != 1 || result.Purged != 1 {
+		t.Fatalf("expected one stale purge, got %#v", result)
+	}
+	if purgeCalls != 1 {
+		t.Fatalf("expected one NodeBB topic purge call, got %d", purgeCalls)
+	}
+	if _, ok := loadDeployManifest(manifestPath).Pages["skills:retired"]; ok {
+		t.Fatalf("expected purged stale manifest entry to be removed")
+	}
+}
+
+func TestDeployWikiPurgeTreatsAlreadyMissingTrackedTopicAsSuccess(t *testing.T) {
+	root := t.TempDir()
+	sourceDir := filepath.Join(root, "pages")
+	if err := os.MkdirAll(filepath.Join(sourceDir, "skills"), 0755); err != nil {
+		t.Fatalf("create source dir: %v", err)
+	}
+	manifestPath := filepath.Join(root, "deploy-manifest.json")
+	if err := saveDeployManifest(manifestPath, wikiDeployManifest{
+		Version: "nodebb-v1",
+		Pages: map[string]wikiDeployManifestPage{
+			"skills:retired": {Hash: "old-hash", Title: "Retired Skill", Namespace: "skills", TID: 7, PID: 42, CID: 3},
+			"skills:gone":    {Hash: "old-hash", Title: "Gone Skill", Namespace: "skills", TID: 8, PID: 43, CID: 3},
+		},
+	}); err != nil {
+		t.Fatalf("write deploy manifest: %v", err)
+	}
+	seen := map[string]int{}
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if r.Method != http.MethodDelete {
+			t.Fatalf("unexpected request %s %s", r.Method, r.URL.Path)
+		}
+		seen[r.URL.Path]++
+		w.Header().Set("Content-Type", "application/json")
+		switch r.URL.Path {
+		case "/api/v3/topics/7":
+			http.Error(w, `{"status":{"message":"topic not found"}}`, http.StatusNotFound)
+		case "/api/v3/topics/8":
+			_ = json.NewEncoder(w).Encode(map[string]any{"status": map[string]any{"code": "ok"}})
+		default:
+			t.Fatalf("unexpected purge path %s", r.URL.Path)
+		}
+	}))
+	defer server.Close()
+
+	result, err := DeployWikiWithOptions(&project.Project{}, DeployWikiOptions{
+		SourceDir:    sourceDir,
+		Endpoint:     server.URL,
+		Token:        "nodebb-token",
+		ManifestPath: manifestPath,
+		StalePolicy:  "purge",
+	}, nil)
+	if err != nil {
+		t.Fatalf("DeployWikiWithOptions stale purge with missing topic failed: %v", err)
+	}
+	if result.Stale != 2 || result.Purged != 2 {
+		t.Fatalf("expected two stale purges, got %#v", result)
+	}
+	if seen["/api/v3/topics/7"] != 1 || seen["/api/v3/topics/8"] != 1 {
+		t.Fatalf("expected one purge call for each tracked topic, got %#v", seen)
+	}
+	manifest := loadDeployManifest(manifestPath)
+	if _, ok := manifest.Pages["skills:retired"]; ok {
+		t.Fatalf("expected already-missing stale manifest entry to be removed")
+	}
+	if _, ok := manifest.Pages["skills:gone"]; ok {
+		t.Fatalf("expected purged stale manifest entry to be removed")
+	}
+}
+
+func TestDeployWikiPurgeDoesNotTargetCurrentGeneratedPages(t *testing.T) {
+	root := t.TempDir()
+	sourceDir := filepath.Join(root, "pages")
+	if err := os.MkdirAll(filepath.Join(sourceDir, "skills"), 0755); err != nil {
+		t.Fatalf("create source dir: %v", err)
+	}
+	generated := "[//]: # (sow-topdata-wiki:managed:start)\n# Athletics\n\nGenerated athletics page\n[//]: # (sow-topdata-wiki:managed:end)\n"
+	if err := os.WriteFile(filepath.Join(sourceDir, "skills", "athletics.md"), []byte(generated), 0644); err != nil {
+		t.Fatalf("write source page: %v", err)
+	}
+	manifestPath := filepath.Join(root, "deploy-manifest.json")
+	if err := saveDeployManifest(manifestPath, wikiDeployManifest{
+		Version: "nodebb-v1",
+		Pages: map[string]wikiDeployManifestPage{
+			"skills:athletics": {
+				Hash:      computeManagedHash(generated),
+				Title:     "Athletics",
+				Namespace: "skills",
+				TID:       7,
+				PID:       42,
+				CID:       3,
+			},
+		},
+	}); err != nil {
+		t.Fatalf("write deploy manifest: %v", err)
+	}
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		t.Fatalf("current generated page must not call NodeBB during matching-hash deploy, got %s %s", r.Method, r.URL.Path)
+	}))
+	defer server.Close()
+
+	result, err := DeployWikiWithOptions(&project.Project{}, DeployWikiOptions{
+		SourceDir:    sourceDir,
+		Endpoint:     server.URL,
+		Token:        "nodebb-token",
+		ManifestPath: manifestPath,
+		StalePolicy:  "purge",
+	}, nil)
+	if err != nil {
+		t.Fatalf("DeployWikiWithOptions current page purge deploy failed: %v", err)
+	}
+	if result.Stale != 0 || result.Purged != 0 || result.Skipped != 1 {
+		t.Fatalf("expected current generated page to skip purge, got %#v", result)
+	}
+	if _, ok := loadDeployManifest(manifestPath).Pages["skills:athletics"]; !ok {
+		t.Fatalf("expected current generated page to remain in deploy manifest")
+	}
+}
+
 func containsAll(haystack string, needles ...string) bool {
 	for _, needle := range needles {
 		if !strings.Contains(haystack, needle) {