Moved goals and roles before knowledge in the BeyondFacts Lab (#1214)

This commit is contained in:
Thorsten Sommer authored and GitHub committed 2026-11-20 19:33:04 +01:00
1 parent 761ec7001d
commit 6cdb0bc551
38 files changed
+334 -186

No files matched your search

@@ -200,7 +200,7 @@ public sealed class BeyondFactsLabStorePersonResearchTests
return path;
}
private string PersonDirectory(Guid projectId) => Path.Combine(this.dataDirectory, BeyondFactsLabStore.ROOT_DIRECTORY_NAME, projectId.ToString("D"), "steps", "05-strategy", "research", "participants");
private string PersonDirectory(Guid projectId) => Path.Combine(this.dataDirectory, BeyondFactsLabStore.ROOT_DIRECTORY_NAME, projectId.ToString("D"), "steps", "strategy", "research", "participants");
private BeyondFactsLabStore CreateStore() => new(NullLogger<BeyondFactsLabStore>.Instance, new BflStorageOptions { DataDirectory = this.dataDirectory });
}
@@ -70,7 +70,7 @@ public sealed class BeyondFactsLabStoreResearchTests
Assert.That(loaded.CreatedAtUtc, Is.EqualTo(research.CreatedAtUtc));
Assert.That(all.Keys, Is.EquivalentTo(new[] { BflResearchTopic.PARTICIPANTS }));
Assert.That(changed.ModifiedAtUtc, Is.GreaterThanOrEqualTo(created.ModifiedAtUtc));
Assert.That(File.Exists(Path.Combine(this.dataDirectory, BeyondFactsLabStore.ROOT_DIRECTORY_NAME, created.ProjectId.ToString("D"), "steps", "05-strategy", "research", "participants.json")), Is.True);
Assert.That(File.Exists(Path.Combine(this.dataDirectory, BeyondFactsLabStore.ROOT_DIRECTORY_NAME, created.ProjectId.ToString("D"), "steps", "strategy", "research", "participants.json")), Is.True);
}
}
@@ -137,7 +137,7 @@ public sealed class BeyondFactsLabStoreResearchTests
private async Task<string> WriteResearchFileAsync(Guid projectId, string fileName, string content)
{
var directory = Path.Combine(this.dataDirectory, BeyondFactsLabStore.ROOT_DIRECTORY_NAME, projectId.ToString("D"), "steps", "05-strategy", "research");
var directory = Path.Combine(this.dataDirectory, BeyondFactsLabStore.ROOT_DIRECTORY_NAME, projectId.ToString("D"), "steps", "strategy", "research");
Directory.CreateDirectory(directory);
var path = Path.Combine(directory, fileName);
await File.WriteAllTextAsync(path, content);
@@ -67,6 +67,20 @@ public sealed class BeyondFactsLabStoreResultTests
}
}
[Test]
public async Task AResultNamesTheStepsOfItsWorkStatesByTheirNames()
{
var store = this.CreateStore();
var created = await store.CreateAsync("Panel");
var result = new BflResult { Draft = new BflResultVersion { Text = "# Positionsblatt", WorkStateRevisions = { [BflStep.GOALS_AND_ROLE] = 3 } } };
await store.SaveResultAsync(created.ProjectId, BflResultKind.POSITION_PAPER, result);
var json = await File.ReadAllTextAsync(Path.Combine(this.dataDirectory, BeyondFactsLabStore.ROOT_DIRECTORY_NAME, created.ProjectId.ToString("D"), "results", "position-paper.json"));
// The files store no position of a step, so that the steps may change their order:
Assert.That(json, Does.Contain("\"GOALS_AND_ROLE\""));
}
[Test]
public async Task ADamagedResultIsNeitherOpenedNorOverwritten()
{
@@ -336,7 +336,7 @@ public sealed class BeyondFactsLabStoreTests
using (Assert.EnterMultipleScope())
{
Assert.That(File.Exists(Path.Combine(this.RootDirectory, created.ProjectId.ToString("D"), "steps", "01-framework", "form.json")), Is.True);
Assert.That(File.Exists(Path.Combine(this.RootDirectory, created.ProjectId.ToString("D"), "steps", "framework", "form.json")), Is.True);
Assert.That(loaded.Get(BflFieldCatalog.FORMAT), Is.EqualTo("Panel discussion"));
Assert.That(changed.ModifiedAtUtc, Is.GreaterThan(created.ModifiedAtUtc));
Assert.That((await store.LoadAsync(created.ProjectId))!.ModifiedAtUtc, Is.EqualTo(changed.ModifiedAtUtc));
@@ -374,7 +374,7 @@ public sealed class BeyondFactsLabStoreTests
form.Set(BflFieldCatalog.CORE_THESES, "Thesis");
await store.SaveFormAsync(created.ProjectId, BflStep.KNOWLEDGE, form);
var json = await File.ReadAllTextAsync(Path.Combine(this.RootDirectory, created.ProjectId.ToString("D"), "steps", "02-knowledge", "form.json"));
var json = await File.ReadAllTextAsync(Path.Combine(this.RootDirectory, created.ProjectId.ToString("D"), "steps", "knowledge", "form.json"));
Assert.That(json, Does.Not.Contain("cardSort"));
}
@@ -384,7 +384,7 @@ public sealed class BeyondFactsLabStoreTests
{
var store = this.CreateStore();
var created = await store.CreateAsync("Panel");
await this.WriteFormFileAsync(created.ProjectId, "04-values", """{ "schemaVersion": 1, "values": { "values_and_concerns": "Text" } }""");
await this.WriteFormFileAsync(created.ProjectId, "values", """{ "schemaVersion": 1, "values": { "values_and_concerns": "Text" } }""");
var form = await store.LoadFormAsync(created.ProjectId, BflStep.VALUES_AND_PERSPECTIVES);
@@ -400,7 +400,7 @@ public sealed class BeyondFactsLabStoreTests
{
var store = this.CreateStore();
var created = await store.CreateAsync("Panel");
await this.WriteFormFileAsync(created.ProjectId, "04-values", """{ "schemaVersion": 2, "values": {}, "cardSort": { "categories": {}, "ownValues": [ null ], "focus": [] } }""");
await this.WriteFormFileAsync(created.ProjectId, "values", """{ "schemaVersion": 2, "values": {}, "cardSort": { "categories": {}, "ownValues": [ null ], "focus": [] } }""");
await Assert.ThrowsAsync<InvalidDataException>(async () => await store.LoadFormAsync(created.ProjectId, BflStep.VALUES_AND_PERSPECTIVES));
}
@@ -413,7 +413,7 @@ public sealed class BeyondFactsLabStoreTests
var form = new BflStepFormData { Simulation = new() { Mode = BflSimulationMode.PANEL_DISCUSSION, People = ["Eva Klein", "Frank Ott"] } };
await store.SaveFormAsync(created.ProjectId, BflStep.TEST_SITUATION, form);
var json = await File.ReadAllTextAsync(Path.Combine(this.RootDirectory, created.ProjectId.ToString("D"), "steps", "06-test", "form.json"));
var json = await File.ReadAllTextAsync(Path.Combine(this.RootDirectory, created.ProjectId.ToString("D"), "steps", "test", "form.json"));
var loaded = (await this.CreateStore().LoadFormAsync(created.ProjectId, BflStep.TEST_SITUATION)).Simulation;
using (Assert.EnterMultipleScope())
@@ -430,7 +430,7 @@ public sealed class BeyondFactsLabStoreTests
{
var store = this.CreateStore();
var created = await store.CreateAsync("Panel");
await this.WriteFormFileAsync(created.ProjectId, "06-test", """{ "schemaVersion": 2, "values": { "test_notes": "Text" } }""");
await this.WriteFormFileAsync(created.ProjectId, "test", """{ "schemaVersion": 2, "values": { "test_notes": "Text" } }""");
var form = await store.LoadFormAsync(created.ProjectId, BflStep.TEST_SITUATION);
@@ -448,7 +448,7 @@ public sealed class BeyondFactsLabStoreTests
{
var store = this.CreateStore();
var created = await store.CreateAsync("Panel");
await this.WriteFormFileAsync(created.ProjectId, "06-test", json);
await this.WriteFormFileAsync(created.ProjectId, "test", json);
await Assert.ThrowsAsync<InvalidDataException>(async () => await store.LoadFormAsync(created.ProjectId, BflStep.TEST_SITUATION));
}
@@ -474,7 +474,7 @@ public sealed class BeyondFactsLabStoreTests
{
var store = this.CreateStore();
var created = await store.CreateAsync("Panel");
var formPath = await this.WriteFormFileAsync(created.ProjectId, "02-knowledge", """{ "schemaVersion": 1, "values": { "field_of_a_newer_version": "kept" } }""");
var formPath = await this.WriteFormFileAsync(created.ProjectId, "knowledge", """{ "schemaVersion": 1, "values": { "field_of_a_newer_version": "kept" } }""");
var form = await store.LoadFormAsync(created.ProjectId, BflStep.KNOWLEDGE);
form.Set(BflFieldCatalog.CORE_THESES, "Thesis");
@@ -494,7 +494,7 @@ public sealed class BeyondFactsLabStoreTests
const string DAMAGED = "{ \"values\": ";
var store = this.CreateStore();
var created = await store.CreateAsync("Panel");
var formPath = await this.WriteFormFileAsync(created.ProjectId, "01-framework", DAMAGED);
var formPath = await this.WriteFormFileAsync(created.ProjectId, "framework", DAMAGED);
var forms = await store.LoadFormsAsync(created.ProjectId);
@@ -514,7 +514,7 @@ public sealed class BeyondFactsLabStoreTests
const string NEWER = """{ "schemaVersion": 4, "values": {} }""";
var store = this.CreateStore();
var created = await store.CreateAsync("Panel");
var formPath = await this.WriteFormFileAsync(created.ProjectId, "05-strategy", NEWER);
var formPath = await this.WriteFormFileAsync(created.ProjectId, "strategy", NEWER);
using (Assert.EnterMultipleScope())
{
@@ -59,7 +59,7 @@ public sealed class BeyondFactsLabStoreThreadTests
Assert.That(loaded.Blocks, Has.Count.EqualTo(1));
Assert.That(((ContentText)loaded.Blocks[0].Content!).Text, Is.EqualTo("Worauf beruht meine Expertise?"));
Assert.That(changed!.ModifiedAtUtc, Is.GreaterThan(created.ModifiedAtUtc), "A conversation is work on the preparation.");
Assert.That(File.Exists(Path.Combine(this.RootDirectory, created.ProjectId.ToString("D"), "steps", "02-knowledge", "thread.json")), Is.True);
Assert.That(File.Exists(Path.Combine(this.RootDirectory, created.ProjectId.ToString("D"), "steps", "knowledge", "thread.json")), Is.True);
}
}
@@ -95,8 +95,8 @@ public sealed class BeyondFactsLabStoreThreadTests
var framework = new BflStepThreadLocation(created.ProjectId, BflStep.FRAMEWORK);
await store.SaveThreadAsync(strategy, BflThreadFactory.Create(strategy));
var stepsDirectory = Path.Combine(this.RootDirectory, created.ProjectId.ToString("D"), "steps");
Directory.CreateDirectory(Path.Combine(stepsDirectory, "01-framework"));
File.Copy(Path.Combine(stepsDirectory, "05-strategy", "thread.json"), Path.Combine(stepsDirectory, "01-framework", "thread.json"));
Directory.CreateDirectory(Path.Combine(stepsDirectory, "framework"));
File.Copy(Path.Combine(stepsDirectory, "strategy", "thread.json"), Path.Combine(stepsDirectory, "framework", "thread.json"));
using (Assert.EnterMultipleScope())
{
@@ -111,7 +111,7 @@ public sealed class BeyondFactsLabStoreThreadTests
var store = this.CreateStore();
var created = await store.CreateAsync("Panel");
var location = new BflStepThreadLocation(created.ProjectId, BflStep.FRAMEWORK);
var path = Path.Combine(this.RootDirectory, created.ProjectId.ToString("D"), "steps", "01-framework", "thread.json");
var path = Path.Combine(this.RootDirectory, created.ProjectId.ToString("D"), "steps", "framework", "thread.json");
Directory.CreateDirectory(Path.GetDirectoryName(path)!);
await File.WriteAllTextAsync(path, "{ damaged");
@@ -75,7 +75,7 @@ public sealed class BeyondFactsLabStoreWorkStateTests
const string DAMAGED = "{ \"draft\": ";
var store = this.CreateStore();
var created = await store.CreateAsync("Panel");
var path = await this.WriteWorkStateFileAsync(created.ProjectId, "02-knowledge", DAMAGED);
var path = await this.WriteWorkStateFileAsync(created.ProjectId, "knowledge", DAMAGED);
var workStates = await store.LoadWorkStatesAsync(created.ProjectId);
@@ -95,7 +95,7 @@ public sealed class BeyondFactsLabStoreWorkStateTests
const string NEWER = """{ "schemaVersion": 2, "fieldSuggestions": {} }""";
var store = this.CreateStore();
var created = await store.CreateAsync("Panel");
var path = await this.WriteWorkStateFileAsync(created.ProjectId, "05-strategy", NEWER);
var path = await this.WriteWorkStateFileAsync(created.ProjectId, "strategy", NEWER);
using (Assert.EnterMultipleScope())
{
@@ -17,7 +17,7 @@ public sealed class BflFieldCatalogTests
{
Assert.That(BflStep.All.Select(step => step.ToString()), Is.EqualTo(new[]
{
"FRAMEWORK", "KNOWLEDGE", "GOALS_AND_ROLE", "VALUES_AND_PERSPECTIVES", "STRATEGY", "TEST_SITUATION", "RESULTS",
"FRAMEWORK", "GOALS_AND_ROLE", "KNOWLEDGE", "VALUES_AND_PERSPECTIVES", "STRATEGY", "TEST_SITUATION", "RESULTS",
}));
}
@@ -26,7 +26,7 @@ public sealed class BflFieldCatalogTests
{
Assert.That(BflStep.All.Select(step => step.FolderName), Is.EqualTo(new[]
{
"01-framework", "02-knowledge", "03-goals", "04-values", "05-strategy", "06-test", "07-results",
"framework", "goals", "knowledge", "values", "strategy", "test", "results",
}));
}
@@ -36,8 +36,8 @@ public sealed class BflFieldCatalogTests
Assert.That(BflFieldCatalog.FIELDS.Select(field => field.Id), Is.EqualTo(new[]
{
"format", "event_topic", "audience", "event_visibility", "contribution_topic", "event_date", "event_location", "event_duration", "contribution_duration", "other_participants", "event_link",
"contribution_summary", "core_theses", "uncertainties", "material_notes",
"goals", "goal_directions",
"contribution_summary", "core_theses", "uncertainties", "material_notes",
"values_and_concerns", "personal_concern", "other_perspectives",
"communication_worries",
"question_type", "difficulty", "test_notes",
@@ -17,8 +17,8 @@ public sealed class BflMarkdownSectionsTests
Assert.That(BflWorkStateSections.SECTIONS.Select(section => $"{section.Step}/{section.Key}"), Is.EqualTo(new[]
{
"FRAMEWORK/FORMAT", "FRAMEWORK/AUDIENCE", "FRAMEWORK/SPEAKING_TIME", "FRAMEWORK/PARTICIPANTS", "FRAMEWORK/CONFLICTS", "FRAMEWORK/OPEN_POINTS",
"KNOWLEDGE/ESTABLISHED", "KNOWLEDGE/UNCERTAINTIES", "KNOWLEDGE/WEAK_POINTS", "KNOWLEDGE/CONTROVERSIES", "KNOWLEDGE/EXPERTISE_LIMITS", "KNOWLEDGE/KEY_MESSAGES", "KNOWLEDGE/OPEN_POINTS",
"GOALS_AND_ROLE/GOAL", "GOALS_AND_ROLE/ROLE", "GOALS_AND_ROLE/REASONS", "GOALS_AND_ROLE/CONSEQUENCES", "GOALS_AND_ROLE/OPEN_POINTS",
"KNOWLEDGE/ESTABLISHED", "KNOWLEDGE/UNCERTAINTIES", "KNOWLEDGE/WEAK_POINTS", "KNOWLEDGE/CONTROVERSIES", "KNOWLEDGE/EXPERTISE_LIMITS", "KNOWLEDGE/KEY_MESSAGES", "KNOWLEDGE/OPEN_POINTS",
"VALUES_AND_PERSPECTIVES/VALUES", "VALUES_AND_PERSPECTIVES/VALUE_CONFLICTS", "VALUES_AND_PERSPECTIVES/PERSONAL_INVOLVEMENT", "VALUES_AND_PERSPECTIVES/PERSPECTIVES", "VALUES_AND_PERSPECTIVES/CONSEQUENCES", "VALUES_AND_PERSPECTIVES/OPEN_POINTS",
"STRATEGY/KEY_MESSAGES", "STRATEGY/STRUCTURE", "STRATEGY/LANGUAGE", "STRATEGY/UNCERTAINTY", "STRATEGY/FRAMING", "STRATEGY/PARTICIPANTS", "STRATEGY/COUNTERARGUMENTS", "STRATEGY/WORRIES", "STRATEGY/OPEN_POINTS",
"TEST_SITUATION/STRENGTHS", "TEST_SITUATION/PRACTICE", "TEST_SITUATION/HARD_QUESTIONS", "TEST_SITUATION/POSITION", "TEST_SITUATION/OPEN_POINTS",
@@ -219,6 +219,57 @@ public sealed class BflPromptOverridesTests
}
}
[Test]
public async Task TheLabNamesTheMarkdownFilesWhichReplaceNoPrompt()
{
await this.WriteAsync(BflPromptLibrary.CORE_PATH, "Ein neuer Kern.");
Directory.CreateDirectory(Path.Combine(this.directory, "Prompts", "steps"));
Directory.CreateDirectory(Path.Combine(this.directory, ".git"));
await File.WriteAllTextAsync(Path.Combine(this.directory, "Prompts", "steps", "02-knowledge.md"), "Ein Schritt unter seinem alten Namen.");
await File.WriteAllTextAsync(Path.Combine(this.directory, "core.md"), "Ein Kern am falschen Ort.");
await File.WriteAllTextAsync(Path.Combine(this.directory, "notes.txt"), "Notizen der Person.");
await File.WriteAllTextAsync(Path.Combine(this.directory, ".draft.md"), "Ein versteckter Entwurf.");
await File.WriteAllTextAsync(Path.Combine(this.directory, ".git", "description.md"), "Eine Datei der Versionsverwaltung.");
var unknown = BflPromptOverrides.FindUnknown(this.directory);
Assert.That(unknown, Is.EqualTo(new[] { "Prompts/steps/02-knowledge.md", "core.md" }));
}
[Test]
public async Task ACopyOfEveryPromptLeavesNoFileUnknown()
{
await BflPromptOverrides.CopyBuiltInAsync(this.directory);
using (Assert.EnterMultipleScope())
{
Assert.That(BflPromptOverrides.FindUnknown(this.directory), Is.Empty);
Assert.That(BflPromptOverrides.FindUnknown(Path.Combine(this.directory, "missing")), Is.Empty, "A missing folder holds no file.");
}
}
[Test]
public async Task TheLabNamesUnknownFilesOnlyWhileTheSettingAllowsPromptOverrides()
{
var settingsManager = new SettingsManager(NullLogger<SettingsManager>.Instance, null!);
var store = new BeyondFactsLabStore(NullLogger<BeyondFactsLabStore>.Instance, new BflStorageOptions { DataDirectory = this.directory });
var service = new BflConversationService(store, null!, settingsManager, null!, null!, NullLogger<BflConversationService>.Instance);
Directory.CreateDirectory(Path.Combine(store.PromptOverridesDirectory, "Prompts", "steps"));
await File.WriteAllTextAsync(Path.Combine(store.PromptOverridesDirectory, "Prompts", "steps", "03-goals.md"), "Ein Schritt unter seinem alten Namen.");
settingsManager.ConfigurationData.BeyondFactsLab.AllowPromptOverrides = true;
var allowed = service.FindUnknownPromptOverrides();
settingsManager.ConfigurationData.BeyondFactsLab.AllowPromptOverrides = false;
var switchedOff = service.FindUnknownPromptOverrides();
using (Assert.EnterMultipleScope())
{
Assert.That(allowed, Is.EqualTo(new[] { "Prompts/steps/03-goals.md" }));
Assert.That(switchedOff, Is.Empty, "Without the setting, the lab reads nothing from the folder.");
}
}
[Test]
public async Task ACopyWithOtherLineBreaksReplacesNothing()
{
@@ -272,11 +272,11 @@ public sealed class BflStalenessTests
var workStates = new Dictionary<BflStep, BflWorkState>();
Confirm(workStates, BflStep.FRAMEWORK);
Confirm(workStates, BflStep.STRATEGY);
Confirm(workStates, BflStep.KNOWLEDGE);
Confirm(workStates, BflStep.GOALS_AND_ROLE);
var revisions = BflStaleness.UpstreamRevisionsOf(BflStep.GOALS_AND_ROLE, workStates);
var revisions = BflStaleness.UpstreamRevisionsOf(BflStep.KNOWLEDGE, workStates);
Assert.That(revisions.Keys, Is.EquivalentTo(new[] { BflStep.FRAMEWORK, BflStep.KNOWLEDGE }));
Assert.That(revisions.Keys, Is.EquivalentTo(new[] { BflStep.FRAMEWORK, BflStep.GOALS_AND_ROLE }));
}
[Test]
+5 -5
View File
@@ -15,9 +15,9 @@ public sealed class BflThreadTests
[Test]
public void TheIdOfAChatFollowsFromItsPlace()
{
// Computed independently, from SHA-256 over "beyondfacts-lab/thread/<project>/05-strategy". A stored chat keeps
// its ID, so this value never changes:
var expected = Guid.Parse("a6e33c75-66c3-8ac8-bae2-8b6a90fb6f19");
// Computed independently, from SHA-256 over "beyondfacts-lab/thread/<project>/strategy". A stored chat keeps its
// ID, so this value never changes:
var expected = Guid.Parse("319d17ef-d388-8f3b-8c3f-f46aab5e4fac");
using (Assert.EnterMultipleScope())
{
@@ -75,8 +75,8 @@ public sealed class BflThreadTests
Assert.That(first, Is.EqualTo(second));
Assert.That(first.GetHashCode(), Is.EqualTo(second.GetHashCode()));
Assert.That(first, Is.Not.EqualTo(new BflStepThreadLocation(PROJECT_ID, BflStep.FRAMEWORK)));
Assert.That(first.Key, Is.EqualTo($"{PROJECT_ID:D}/05-strategy"));
Assert.That(first.ChatName, Is.EqualTo("05-strategy"));
Assert.That(first.Key, Is.EqualTo($"{PROJECT_ID:D}/strategy"));
Assert.That(first.ChatName, Is.EqualTo("strategy"));
}
}