Edit lock acquisition

2026-05-16 23:05:42 +02:00
parent 8da3f42c2f
commit 3dc69bb070
3 changed files with 184 additions and 7 deletions
@@ -262,13 +262,19 @@ func TestDeployWikiAdoptsExistingNodeBBPageWhenManifestIsMissingWithoutCreate(t
 		case r.Method == http.MethodGet && r.URL.Path == "/api/v3/posts/88":
 			w.Header().Set("Content-Type", "application/json")
 			_ = json.NewEncoder(w).Encode(map[string]any{"response": map[string]any{"pid": 88, "tid": 77, "content": old}})
+		case r.Method == http.MethodPut && r.URL.Path == "/api/v3/plugins/westgate-wiki/edit-lock":
+			respondWikiEditLock(t, w, r, 77, "adopt-lock")
 		case r.Method == http.MethodPut && r.URL.Path == "/api/v3/posts/88":
 			var req struct {
-				Content string `json:"content"`
+				Content           string `json:"content"`
+				WikiEditLockToken string `json:"wikiEditLockToken"`
 			}
 			if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
 				t.Fatalf("decode update request: %v", err)
 			}
+			if req.WikiEditLockToken != "adopt-lock" {
+				t.Fatalf("expected adopted update to include wiki edit lock token, got %q", req.WikiEditLockToken)
+			}
 			updated = req.Content
 			w.Header().Set("Content-Type", "application/json")
 			_ = json.NewEncoder(w).Encode(map[string]any{"response": map[string]any{"pid": 88, "tid": 77}})
@@ -356,13 +362,19 @@ func TestDeployWikiMergesHTMLManagedAndManualRegions(t *testing.T) {
 		case r.Method == http.MethodGet && r.URL.Path == "/api/v3/posts/42":
 			w.Header().Set("Content-Type", "application/json")
 			_ = json.NewEncoder(w).Encode(map[string]any{"response": map[string]any{"pid": 42, "tid": 7, "content": old}})
+		case r.Method == http.MethodPut && r.URL.Path == "/api/v3/plugins/westgate-wiki/edit-lock":
+			respondWikiEditLock(t, w, r, 7, "merge-lock")
 		case r.Method == http.MethodPut && r.URL.Path == "/api/v3/posts/42":
 			var req struct {
-				Content string `json:"content"`
+				Content           string `json:"content"`
+				WikiEditLockToken string `json:"wikiEditLockToken"`
 			}
 			if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
 				t.Fatalf("decode update request: %v", err)
 			}
+			if req.WikiEditLockToken != "merge-lock" {
+				t.Fatalf("expected update to include wiki edit lock token, got %q", req.WikiEditLockToken)
+			}
 			updated = req.Content
 			w.Header().Set("Content-Type", "application/json")
 			_ = json.NewEncoder(w).Encode(map[string]any{"response": map[string]any{"pid": 42, "tid": 7}})
@@ -389,6 +401,94 @@ func TestDeployWikiMergesHTMLManagedAndManualRegions(t *testing.T) {
 	}
 }

+func TestDeployWikiUpdateAcquiresWestgateWikiEditLock(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:page=skills:athletics -->
+<!-- sow-topdata-wiki:managed:start hash="sha256:local" -->
+<h1>Athletics</h1>
+<p>Generated athletics page</p>
+<!-- sow-topdata-wiki:managed:end -->
+`
+	if err := os.WriteFile(filepath.Join(sourceDir, "skills", "athletics.html"), []byte(generated), 0644); err != nil {
+		t.Fatalf("write source page: %v", err)
+	}
+	old := `<!-- sow-topdata-wiki:page=skills:athletics -->
+<!-- sow-topdata-wiki:managed:start hash="sha256:old" -->
+<h1>Athletics</h1>
+<p>Old athletics page</p>
+<!-- sow-topdata-wiki:managed:end -->
+`
+	manifestPath := filepath.Join(root, "deploy-manifest.json")
+	if err := saveDeployManifest(manifestPath, wikiDeployManifest{
+		Version: "nodebb-v1",
+		Pages: map[string]wikiDeployManifestPage{
+			"skills:athletics": {Hash: computeManagedHash(old), TID: 7, PID: 42, CID: 3},
+		},
+	}); err != nil {
+		t.Fatalf("write deploy manifest: %v", err)
+	}
+
+	lockAcquired := false
+	var updateToken string
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		switch {
+		case r.Method == http.MethodGet && r.URL.Path == "/api/v3/posts/42":
+			w.Header().Set("Content-Type", "application/json")
+			_ = json.NewEncoder(w).Encode(map[string]any{"response": map[string]any{"pid": 42, "tid": 7, "content": old}})
+		case r.Method == http.MethodPut && r.URL.Path == "/api/v3/plugins/westgate-wiki/edit-lock":
+			var req struct {
+				TID int `json:"tid"`
+			}
+			if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
+				t.Fatalf("decode edit lock request: %v", err)
+			}
+			if req.TID != 7 {
+				t.Fatalf("expected edit lock for tid 7, got %d", req.TID)
+			}
+			lockAcquired = true
+			w.Header().Set("Content-Type", "application/json")
+			_ = json.NewEncoder(w).Encode(map[string]any{"response": map[string]any{"status": "ok", "tid": 7, "token": "lock-token"}})
+		case r.Method == http.MethodPut && r.URL.Path == "/api/v3/posts/42":
+			var req struct {
+				Content           string `json:"content"`
+				WikiEditLockToken string `json:"wikiEditLockToken"`
+			}
+			if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
+				t.Fatalf("decode update request: %v", err)
+			}
+			updateToken = req.WikiEditLockToken
+			w.Header().Set("Content-Type", "application/json")
+			_ = json.NewEncoder(w).Encode(map[string]any{"response": map[string]any{"pid": 42, "tid": 7}})
+		default:
+			t.Fatalf("unexpected request %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,
+	}, nil)
+	if err != nil {
+		t.Fatalf("DeployWikiWithOptions update failed: %v", err)
+	}
+	if result.Updated != 1 {
+		t.Fatalf("expected one update, got %#v", result)
+	}
+	if !lockAcquired {
+		t.Fatalf("expected deployer to acquire a wiki edit lock before update")
+	}
+	if updateToken != "lock-token" {
+		t.Fatalf("expected update to include wiki edit lock token, got %q", updateToken)
+	}
+}
+
 func TestDeployWikiReportsAndArchivesStalePages(t *testing.T) {
 	root := t.TempDir()
 	sourceDir := filepath.Join(root, "pages")
@@ -407,15 +507,23 @@ func TestDeployWikiReportsAndArchivesStalePages(t *testing.T) {

 	var archived string
 	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if r.Method == http.MethodPut && r.URL.Path == "/api/v3/plugins/westgate-wiki/edit-lock" {
+			respondWikiEditLock(t, w, r, 7, "archive-lock")
+			return
+		}
 		if r.Method != http.MethodPut || r.URL.Path != "/api/v3/posts/42" {
 			t.Fatalf("unexpected request %s %s", r.Method, r.URL.Path)
 		}
 		var req struct {
-			Content string `json:"content"`
+			Content           string `json:"content"`
+			WikiEditLockToken string `json:"wikiEditLockToken"`
 		}
 		if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
 			t.Fatalf("decode archive request: %v", err)
 		}
+		if req.WikiEditLockToken != "archive-lock" {
+			t.Fatalf("expected archive to include wiki edit lock token, got %q", req.WikiEditLockToken)
+		}
 		archived = req.Content
 		w.Header().Set("Content-Type", "application/json")
 		_ = json.NewEncoder(w).Encode(map[string]any{"response": map[string]any{"pid": 42, "tid": 7}})
@@ -468,3 +576,18 @@ func containsAll(haystack string, needles ...string) bool {
 	}
 	return true
 }
+
+func respondWikiEditLock(t *testing.T, w http.ResponseWriter, r *http.Request, expectedTID int, token string) {
+	t.Helper()
+	var req struct {
+		TID int `json:"tid"`
+	}
+	if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
+		t.Fatalf("decode edit lock request: %v", err)
+	}
+	if req.TID != expectedTID {
+		t.Fatalf("expected edit lock for tid %d, got %d", expectedTID, req.TID)
+	}
+	w.Header().Set("Content-Type", "application/json")
+	_ = json.NewEncoder(w).Encode(map[string]any{"response": map[string]any{"status": "ok", "tid": expectedTID, "token": token}})
+}