fix(galaxyrepository): scoped browse surfaces ancestors as navigation-only nodes (scadaproj#42)
A browse-subtree scope such as Plant/LineA/* filtered out Plant and Plant/LineA, so scoped lazy browse from the root was empty and DiscoverHierarchy returned orphans. Out-of-scope ancestors of an allowed object are now returned as navigation-only containers: attributes stripped, child_has_children = true, and only their children on the path to an allowed object are listed (siblings stay hidden). DiscoverHierarchy reports them in GalaxyHierarchyQueryResult.NavigationAncestorCount; WatchDeployEvents subtracts it so its scoped counts stay allowed-objects-only. - tests: ScopedAncestorBrowseTests; deploy-event scope test updated - IGalaxyBrowseScopeProvider documents the semantics; CLAUDE.md 0.2.1 notes - code-reviews: GalaxyRepository-002 Resolved; README regenerated Claude-Session: https://claude.ai/code/session_01GT67AEHd2Acv1YPwGfXEoV
This commit is contained in:
@@ -7,6 +7,12 @@ Shared Galaxy object-hierarchy SQL browse + `galaxy_repository.v1` gRPC service
|
|||||||
Version bumped in `Directory.Build.props`, not packed or pushed; consumers stay on `0.2.0`.
|
Version bumped in `Directory.Build.props`, not packed or pushed; consumers stay on `0.2.0`.
|
||||||
- GalaxyRepository-001 (scadaproj#41): the per-cache-entry filter memos of both projectors are now
|
- GalaxyRepository-001 (scadaproj#41): the per-cache-entry filter memos of both projectors are now
|
||||||
`ProjectionMemo<T>`, capped at 64 signatures (FIFO; an evicted signature is recomputed, same answer).
|
`ProjectionMemo<T>`, capped at 64 signatures (FIFO; an evicted signature is recomputed, same answer).
|
||||||
|
- GalaxyRepository-002 (scadaproj#42): a browse-subtree scope (`Plant/LineA/*`) no longer hides the
|
||||||
|
allowed subtree's ancestors. `BrowseChildren` and `DiscoverHierarchy` return them as
|
||||||
|
**navigation-only** nodes — attributes stripped, only the path to an allowed object listed, siblings
|
||||||
|
still hidden. **Behaviour change for consumers:** a scoped `DiscoverHierarchy` now includes those
|
||||||
|
ancestors (`GalaxyHierarchyQueryResult.NavigationAncestorCount` says how many); `WatchDeployEvents`
|
||||||
|
still counts allowed objects only. Semantics documented on `IGalaxyBrowseScopeProvider`.
|
||||||
|
|
||||||
## Index history (migrated from the scadaproj root CLAUDE.md)
|
## Index history (migrated from the scadaproj root CLAUDE.md)
|
||||||
|
|
||||||
|
|||||||
@@ -60,7 +60,9 @@ public static class GalaxyBrowseProjector
|
|||||||
List<bool> hasChildren = new(Math.Max(0, end - offset));
|
List<bool> hasChildren = new(Math.Max(0, end - offset));
|
||||||
for (int index = offset; index < end; index++)
|
for (int index = offset; index < end; index++)
|
||||||
{
|
{
|
||||||
page.Add(CloneObject(filtered.Children[index].Object, includeAttributes));
|
// A navigation-only ancestor of the browse scope never carries attributes: it is in
|
||||||
|
// the reply only so the caller can reach the allowed subtree (GalaxyRepository-002).
|
||||||
|
page.Add(CloneObject(filtered.Children[index].Object, includeAttributes && !filtered.NavigationOnly[index]));
|
||||||
hasChildren.Add(filtered.HasMatchingDescendant[index]);
|
hasChildren.Add(filtered.HasMatchingDescendant[index]);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -134,10 +136,22 @@ public static class GalaxyBrowseProjector
|
|||||||
|
|
||||||
List<GalaxyObjectView> matched = [];
|
List<GalaxyObjectView> matched = [];
|
||||||
List<bool> hasMatching = [];
|
List<bool> hasMatching = [];
|
||||||
|
List<bool> navigationOnly = [];
|
||||||
foreach (GalaxyObjectView view in directChildren)
|
foreach (GalaxyObjectView view in directChildren)
|
||||||
{
|
{
|
||||||
if (!MatchesBrowseSubtrees(view, state.BrowseSubtreeGlobs))
|
if (!MatchesBrowseSubtrees(view, state.BrowseSubtreeGlobs))
|
||||||
{
|
{
|
||||||
|
// Out of scope itself, but an ancestor of an allowed object (scope
|
||||||
|
// `Plant/LineA/*` → `Plant`, `Plant/LineA`): surface it as a navigation-
|
||||||
|
// only container, or scoped lazy browse from the root is empty
|
||||||
|
// (GalaxyRepository-002). Its other children stay hidden because the same
|
||||||
|
// rule applies one level down when the caller expands it.
|
||||||
|
if (HasMatchingDescendant(view, state.Entry.Index, state.Request, state.BrowseSubtreeGlobs))
|
||||||
|
{
|
||||||
|
matched.Add(view);
|
||||||
|
hasMatching.Add(true);
|
||||||
|
navigationOnly.Add(true);
|
||||||
|
}
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
if (!MatchesFilters(view.Object, state.Request))
|
if (!MatchesFilters(view.Object, state.Request))
|
||||||
@@ -150,14 +164,16 @@ public static class GalaxyBrowseProjector
|
|||||||
{
|
{
|
||||||
matched.Add(view);
|
matched.Add(view);
|
||||||
hasMatching.Add(true);
|
hasMatching.Add(true);
|
||||||
|
navigationOnly.Add(false);
|
||||||
}
|
}
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
matched.Add(view);
|
matched.Add(view);
|
||||||
hasMatching.Add(HasMatchingDescendant(view, state.Entry.Index, state.Request, state.BrowseSubtreeGlobs));
|
hasMatching.Add(HasMatchingDescendant(view, state.Entry.Index, state.Request, state.BrowseSubtreeGlobs));
|
||||||
|
navigationOnly.Add(false);
|
||||||
}
|
}
|
||||||
|
|
||||||
return new FilteredChildren(matched, hasMatching);
|
return new FilteredChildren(matched, hasMatching, navigationOnly);
|
||||||
},
|
},
|
||||||
(Entry: entry, ParentId: parentId, Request: request, BrowseSubtreeGlobs: browseSubtreeGlobs));
|
(Entry: entry, ParentId: parentId, Request: request, BrowseSubtreeGlobs: browseSubtreeGlobs));
|
||||||
}
|
}
|
||||||
@@ -282,5 +298,6 @@ public static class GalaxyBrowseProjector
|
|||||||
|
|
||||||
private sealed record FilteredChildren(
|
private sealed record FilteredChildren(
|
||||||
IReadOnlyList<GalaxyObjectView> Children,
|
IReadOnlyList<GalaxyObjectView> Children,
|
||||||
IReadOnlyList<bool> HasMatchingDescendant);
|
IReadOnlyList<bool> HasMatchingDescendant,
|
||||||
|
IReadOnlyList<bool> NavigationOnly);
|
||||||
}
|
}
|
||||||
|
|||||||
+73
-11
@@ -26,7 +26,7 @@ public static class GalaxyHierarchyProjector
|
|||||||
/// <see cref="ProjectionMemo{TValue}.Capacity"/> signatures, because the signature is
|
/// <see cref="ProjectionMemo{TValue}.Capacity"/> signatures, because the signature is
|
||||||
/// client-controlled (GalaxyRepository-001).
|
/// client-controlled (GalaxyRepository-001).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
private static readonly ConditionalWeakTable<GalaxyHierarchyCacheEntry, ProjectionMemo<IReadOnlyList<GalaxyObjectView>>> FilteredViewCache = new();
|
private static readonly ConditionalWeakTable<GalaxyHierarchyCacheEntry, ProjectionMemo<FilteredViews>> FilteredViewCache = new();
|
||||||
|
|
||||||
/// <summary>Number of filter signatures currently memoized for <paramref name="entry"/> (tests).</summary>
|
/// <summary>Number of filter signatures currently memoized for <paramref name="entry"/> (tests).</summary>
|
||||||
internal static int MemoCount(GalaxyHierarchyCacheEntry entry) =>
|
internal static int MemoCount(GalaxyHierarchyCacheEntry entry) =>
|
||||||
@@ -83,28 +83,33 @@ public static class GalaxyHierarchyProjector
|
|||||||
}
|
}
|
||||||
|
|
||||||
string filterSignature = ComputeFilterSignature(request, browseSubtreeGlobs);
|
string filterSignature = ComputeFilterSignature(request, browseSubtreeGlobs);
|
||||||
IReadOnlyList<GalaxyObjectView> matchedViews = GetFilteredViews(
|
FilteredViews filtered = GetFilteredViews(
|
||||||
entry,
|
entry,
|
||||||
request,
|
request,
|
||||||
browseSubtreeGlobs,
|
browseSubtreeGlobs,
|
||||||
maxDepth,
|
maxDepth,
|
||||||
filterSignature);
|
filterSignature);
|
||||||
|
IReadOnlyList<GalaxyObjectView> matchedViews = filtered.Views;
|
||||||
|
|
||||||
bool includeAttributes = IncludeAttributes(request);
|
bool includeAttributes = IncludeAttributes(request);
|
||||||
List<GalaxyObject> page = new(Math.Min(pageSize, Math.Max(0, matchedViews.Count - offset)));
|
List<GalaxyObject> page = new(Math.Min(pageSize, Math.Max(0, matchedViews.Count - offset)));
|
||||||
int end = (int)Math.Min((long)offset + pageSize, matchedViews.Count);
|
int end = (int)Math.Min((long)offset + pageSize, matchedViews.Count);
|
||||||
for (int index = offset; index < end; index++)
|
for (int index = offset; index < end; index++)
|
||||||
{
|
{
|
||||||
page.Add(CloneObject(matchedViews[index].Object, includeAttributes));
|
// Navigation-only scope ancestors never carry attributes (GalaxyRepository-002).
|
||||||
|
page.Add(CloneObject(matchedViews[index].Object, includeAttributes && !filtered.NavigationOnly[index]));
|
||||||
}
|
}
|
||||||
|
|
||||||
return new GalaxyHierarchyQueryResult(
|
return new GalaxyHierarchyQueryResult(
|
||||||
page,
|
page,
|
||||||
matchedViews.Count,
|
matchedViews.Count,
|
||||||
filterSignature);
|
filterSignature)
|
||||||
|
{
|
||||||
|
NavigationAncestorCount = filtered.NavigationAncestorCount,
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
private static IReadOnlyList<GalaxyObjectView> GetFilteredViews(
|
private static FilteredViews GetFilteredViews(
|
||||||
GalaxyHierarchyCacheEntry entry,
|
GalaxyHierarchyCacheEntry entry,
|
||||||
DiscoverHierarchyRequest request,
|
DiscoverHierarchyRequest request,
|
||||||
IReadOnlyList<string>? browseSubtreeGlobs,
|
IReadOnlyList<string>? browseSubtreeGlobs,
|
||||||
@@ -116,29 +121,86 @@ public static class GalaxyHierarchyProjector
|
|||||||
IReadOnlyList<GalaxyObjectView> views = entry.Index.ObjectViews;
|
IReadOnlyList<GalaxyObjectView> views = entry.Index.ObjectViews;
|
||||||
GalaxyObjectView? root = ResolveRoot(request, entry.Index);
|
GalaxyObjectView? root = ResolveRoot(request, entry.Index);
|
||||||
|
|
||||||
ProjectionMemo<IReadOnlyList<GalaxyObjectView>> memo =
|
ProjectionMemo<FilteredViews> memo =
|
||||||
FilteredViewCache.GetValue(entry, static _ => new ProjectionMemo<IReadOnlyList<GalaxyObjectView>>());
|
FilteredViewCache.GetValue(entry, static _ => new ProjectionMemo<FilteredViews>());
|
||||||
|
|
||||||
return memo.GetOrAdd(
|
return memo.GetOrAdd(
|
||||||
filterSignature,
|
filterSignature,
|
||||||
static (_, state) =>
|
static (_, state) =>
|
||||||
{
|
{
|
||||||
List<GalaxyObjectView> matched = [];
|
HashSet<int> inScope = [];
|
||||||
foreach (GalaxyObjectView view in state.Views)
|
foreach (GalaxyObjectView view in state.Views)
|
||||||
{
|
{
|
||||||
if (MatchesRoot(view, state.Root, state.MaxDepth)
|
if (MatchesRoot(view, state.Root, state.MaxDepth)
|
||||||
&& MatchesBrowseSubtrees(view, state.BrowseSubtreeGlobs)
|
&& MatchesBrowseSubtrees(view, state.BrowseSubtreeGlobs)
|
||||||
&& MatchesFilters(view.Object, state.Request))
|
&& MatchesFilters(view.Object, state.Request))
|
||||||
{
|
{
|
||||||
matched.Add(view);
|
inScope.Add(view.Object.GobjectId);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return matched;
|
// A scope such as `Plant/LineA/*` excludes `Plant` and `Plant/LineA` themselves,
|
||||||
|
// leaving the allowed objects with no parent in the reply (GalaxyRepository-002).
|
||||||
|
// Ancestors of an allowed object are returned as navigation-only nodes —
|
||||||
|
// attribute-stripped — when the request would otherwise have returned them
|
||||||
|
// (inside root/depth, passing the request filters).
|
||||||
|
HashSet<int> ancestors = state.BrowseSubtreeGlobs is { Count: > 0 }
|
||||||
|
? CollectAncestors(inScope, state.Index)
|
||||||
|
: [];
|
||||||
|
|
||||||
|
List<GalaxyObjectView> matched = [];
|
||||||
|
List<bool> navigationOnly = [];
|
||||||
|
int navigationCount = 0;
|
||||||
|
foreach (GalaxyObjectView view in state.Views)
|
||||||
|
{
|
||||||
|
int id = view.Object.GobjectId;
|
||||||
|
if (inScope.Contains(id))
|
||||||
|
{
|
||||||
|
matched.Add(view);
|
||||||
|
navigationOnly.Add(false);
|
||||||
|
}
|
||||||
|
else if (ancestors.Contains(id)
|
||||||
|
&& MatchesRoot(view, state.Root, state.MaxDepth)
|
||||||
|
&& MatchesFilters(view.Object, state.Request))
|
||||||
|
{
|
||||||
|
matched.Add(view);
|
||||||
|
navigationOnly.Add(true);
|
||||||
|
navigationCount++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return new FilteredViews(matched, navigationOnly, navigationCount);
|
||||||
},
|
},
|
||||||
(Views: views, Root: root, MaxDepth: maxDepth, BrowseSubtreeGlobs: browseSubtreeGlobs, Request: request));
|
(Views: views, Index: entry.Index, Root: root, MaxDepth: maxDepth, BrowseSubtreeGlobs: browseSubtreeGlobs, Request: request));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// The out-of-scope ancestors of every in-scope object. Cycle-safe: a walk stops at any id
|
||||||
|
/// already seen, which also stops it re-walking a chain another object already covered.
|
||||||
|
/// </summary>
|
||||||
|
private static HashSet<int> CollectAncestors(HashSet<int> inScope, GalaxyHierarchyIndex index)
|
||||||
|
{
|
||||||
|
HashSet<int> ancestors = [];
|
||||||
|
foreach (int id in inScope)
|
||||||
|
{
|
||||||
|
int parentId = index.ObjectViewsById.TryGetValue(id, out GalaxyObjectView? view) ? view.Object.ParentGobjectId : 0;
|
||||||
|
while (parentId != 0
|
||||||
|
&& !inScope.Contains(parentId)
|
||||||
|
&& ancestors.Add(parentId)
|
||||||
|
&& index.ObjectViewsById.TryGetValue(parentId, out GalaxyObjectView? parent))
|
||||||
|
{
|
||||||
|
parentId = parent.Object.ParentGobjectId;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return ancestors;
|
||||||
|
}
|
||||||
|
|
||||||
|
private sealed record FilteredViews(
|
||||||
|
IReadOnlyList<GalaxyObjectView> Views,
|
||||||
|
IReadOnlyList<bool> NavigationOnly,
|
||||||
|
int NavigationAncestorCount);
|
||||||
|
|
||||||
/// <summary>Finds an object in the hierarchy by its tag address.</summary>
|
/// <summary>Finds an object in the hierarchy by its tag address.</summary>
|
||||||
/// <param name="entry">The Galaxy hierarchy cache entry.</param>
|
/// <param name="entry">The Galaxy hierarchy cache entry.</param>
|
||||||
/// <param name="tagAddress">The tag address to search for.</param>
|
/// <param name="tagAddress">The tag address to search for.</param>
|
||||||
|
|||||||
+9
-1
@@ -13,4 +13,12 @@ namespace ZB.MOM.WW.GalaxyRepository;
|
|||||||
public sealed record GalaxyHierarchyQueryResult(
|
public sealed record GalaxyHierarchyQueryResult(
|
||||||
IReadOnlyList<GalaxyObject> Objects,
|
IReadOnlyList<GalaxyObject> Objects,
|
||||||
int TotalObjectCount,
|
int TotalObjectCount,
|
||||||
string FilterSignature);
|
string FilterSignature)
|
||||||
|
{
|
||||||
|
/// <summary>
|
||||||
|
/// How many of the <see cref="TotalObjectCount"/> objects are navigation-only ancestors
|
||||||
|
/// of a browse-subtree scope: returned (attribute-stripped) only so a client can attach the
|
||||||
|
/// allowed objects to a tree, not because they are themselves in scope. Always 0 unscoped.
|
||||||
|
/// </summary>
|
||||||
|
public int NavigationAncestorCount { get; init; }
|
||||||
|
}
|
||||||
|
|||||||
+3
-1
@@ -246,7 +246,9 @@ public sealed class GalaxyRepositoryGrpcService(
|
|||||||
cache.Current,
|
cache.Current,
|
||||||
new DiscoverHierarchyRequest(),
|
new DiscoverHierarchyRequest(),
|
||||||
browseSubtrees);
|
browseSubtrees);
|
||||||
objectCount = scoped.TotalObjectCount;
|
// Count the objects the scope allows, not the navigation-only ancestors that the
|
||||||
|
// projection adds so a tree can be built (GalaxyRepository-002).
|
||||||
|
objectCount = scoped.TotalObjectCount - scoped.NavigationAncestorCount;
|
||||||
attributeCount = scoped.Objects.Sum(obj => obj.Attributes.Count);
|
attributeCount = scoped.Objects.Sum(obj => obj.Attributes.Count);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+17
@@ -8,6 +8,23 @@ namespace ZB.MOM.WW.GalaxyRepository.Grpc;
|
|||||||
/// identity without the library knowing the host's authorization model. The default
|
/// identity without the library knowing the host's authorization model. The default
|
||||||
/// <see cref="NullGalaxyBrowseScopeProvider"/> applies no scoping (full hierarchy).
|
/// <see cref="NullGalaxyBrowseScopeProvider"/> applies no scoping (full hierarchy).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// <para>
|
||||||
|
/// Each glob is matched (anchored, case-insensitive, <c>*</c>/<c>?</c>) against an
|
||||||
|
/// object's slash-separated contained path. An object whose path matches any glob is
|
||||||
|
/// <b>allowed</b> and is returned in full.
|
||||||
|
/// </para>
|
||||||
|
/// <para>
|
||||||
|
/// <b>Ancestors of an allowed object are navigation-only.</b> With <c>Plant/LineA/*</c>,
|
||||||
|
/// neither <c>Plant</c> nor <c>Plant/LineA</c> matches, but both are returned so a client
|
||||||
|
/// can reach the allowed subtree: by <c>BrowseChildren</c> (with
|
||||||
|
/// <c>child_has_children = true</c>) and by <c>DiscoverHierarchy</c>. They are returned
|
||||||
|
/// with their attributes stripped, and only their children on the path to an allowed
|
||||||
|
/// object are listed — siblings such as <c>Plant/LineB</c> stay hidden. An ancestor is
|
||||||
|
/// surfaced only when an allowed descendant also passes the request's own filters.
|
||||||
|
/// <c>WatchDeployEvents</c> counts allowed objects only.
|
||||||
|
/// </para>
|
||||||
|
/// </remarks>
|
||||||
public interface IGalaxyBrowseScopeProvider
|
public interface IGalaxyBrowseScopeProvider
|
||||||
{
|
{
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|||||||
+8
-5
@@ -80,14 +80,17 @@ public sealed class GalaxyRepositoryGrpcServiceScopeTests
|
|||||||
Assert.Equal(6, full.TotalObjectCount);
|
Assert.Equal(6, full.TotalObjectCount);
|
||||||
Assert.Equal(4, full.Objects.Sum(obj => obj.Attributes.Count));
|
Assert.Equal(4, full.Objects.Sum(obj => obj.Attributes.Count));
|
||||||
|
|
||||||
// The glob selects only LineA's two leaf objects (Pump01, Valve01), each with one
|
// The glob allows only LineA's two leaf objects (Pump01, Valve01), each with one
|
||||||
// attribute. That scoped projection (2 objects / 2 attributes) is a non-empty subset
|
// attribute. The projection also returns their two ancestors (PlantArea, LineA) as
|
||||||
// distinct from both the full count and the raw notifier values below.
|
// attribute-stripped navigation nodes (GalaxyRepository-002); the deploy event must count
|
||||||
|
// only the 2 allowed objects / 2 attributes — a non-empty subset distinct from both the
|
||||||
|
// full count and the raw notifier values below.
|
||||||
GalaxyHierarchyQueryResult scopedProjection = GalaxyHierarchyProjector.Project(
|
GalaxyHierarchyQueryResult scopedProjection = GalaxyHierarchyProjector.Project(
|
||||||
entry,
|
entry,
|
||||||
new DiscoverHierarchyRequest(),
|
new DiscoverHierarchyRequest(),
|
||||||
browseSubtreeGlobs: ["PlantArea/LineA/*"]);
|
browseSubtreeGlobs: ["PlantArea/LineA/*"]);
|
||||||
Assert.Equal(2, scopedProjection.TotalObjectCount);
|
Assert.Equal(4, scopedProjection.TotalObjectCount);
|
||||||
|
Assert.Equal(2, scopedProjection.NavigationAncestorCount);
|
||||||
Assert.Equal(2, scopedProjection.Objects.Sum(obj => obj.Attributes.Count));
|
Assert.Equal(2, scopedProjection.Objects.Sum(obj => obj.Attributes.Count));
|
||||||
|
|
||||||
// Publish a deploy event whose RAW counts differ from both full and scoped, so an
|
// Publish a deploy event whose RAW counts differ from both full and scoped, so an
|
||||||
@@ -114,7 +117,7 @@ public sealed class GalaxyRepositoryGrpcServiceScopeTests
|
|||||||
new TestServerCallContext());
|
new TestServerCallContext());
|
||||||
|
|
||||||
DeployEvent emitted = Assert.Single(responseStream.Written);
|
DeployEvent emitted = Assert.Single(responseStream.Written);
|
||||||
Assert.Equal(scopedProjection.TotalObjectCount, emitted.ObjectCount);
|
Assert.Equal(2, emitted.ObjectCount);
|
||||||
Assert.Equal(2, emitted.AttributeCount);
|
Assert.Equal(2, emitted.AttributeCount);
|
||||||
// The raw notifier values were overridden by the scoped re-projection.
|
// The raw notifier values were overridden by the scoped re-projection.
|
||||||
Assert.NotEqual(999, emitted.ObjectCount);
|
Assert.NotEqual(999, emitted.ObjectCount);
|
||||||
|
|||||||
+131
@@ -0,0 +1,131 @@
|
|||||||
|
using ZB.MOM.WW.GalaxyRepository;
|
||||||
|
using ZB.MOM.WW.GalaxyRepository.Grpc;
|
||||||
|
|
||||||
|
namespace ZB.MOM.WW.GalaxyRepository.Tests;
|
||||||
|
|
||||||
|
/// <summary>
|
||||||
|
/// GalaxyRepository-002 (scadaproj#42): a browse-subtree scope such as <c>Plant/LineA/*</c>
|
||||||
|
/// hid the ancestors of the allowed subtree, so scoped lazy browse from the root was empty.
|
||||||
|
/// Ancestors must now surface as attribute-stripped navigation containers, while their
|
||||||
|
/// non-allowed children stay hidden.
|
||||||
|
/// </summary>
|
||||||
|
public sealed class ScopedAncestorBrowseTests
|
||||||
|
{
|
||||||
|
private static readonly string[] Scope = ["Plant/LineA/*"];
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Root_browse_surfaces_the_ancestor_as_a_navigation_container()
|
||||||
|
{
|
||||||
|
GalaxyBrowseChildrenResult result = Browse(new BrowseChildrenRequest());
|
||||||
|
|
||||||
|
GalaxyObject plant = Assert.Single(result.Children);
|
||||||
|
Assert.Equal("Plant", plant.TagName);
|
||||||
|
Assert.True(result.ChildHasChildren[0]);
|
||||||
|
Assert.Empty(plant.Attributes);
|
||||||
|
Assert.Equal(1, result.TotalChildCount);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Ancestor_browse_shows_only_the_path_to_the_allowed_subtree()
|
||||||
|
{
|
||||||
|
GalaxyBrowseChildrenResult result = Browse(new BrowseChildrenRequest { ParentContainedPath = "Plant" });
|
||||||
|
|
||||||
|
GalaxyObject lineA = Assert.Single(result.Children);
|
||||||
|
Assert.Equal("Plant.LineA", lineA.TagName);
|
||||||
|
Assert.True(result.ChildHasChildren[0]);
|
||||||
|
Assert.Empty(lineA.Attributes);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Allowed_subtree_is_returned_with_its_attributes()
|
||||||
|
{
|
||||||
|
GalaxyBrowseChildrenResult result = Browse(new BrowseChildrenRequest { ParentContainedPath = "Plant/LineA" });
|
||||||
|
|
||||||
|
GalaxyObject pump = Assert.Single(result.Children);
|
||||||
|
Assert.Equal("Plant.LineA.Pump01", pump.TagName);
|
||||||
|
Assert.Single(pump.Attributes);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Non_allowed_sibling_subtree_does_not_leak()
|
||||||
|
{
|
||||||
|
GalaxyBrowseChildrenResult result = Browse(new BrowseChildrenRequest { ParentContainedPath = "Plant/LineB" });
|
||||||
|
|
||||||
|
Assert.Empty(result.Children);
|
||||||
|
Assert.Equal(0, result.TotalChildCount);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Ancestor_is_not_surfaced_when_no_allowed_descendant_matches_the_request_filter()
|
||||||
|
{
|
||||||
|
GalaxyBrowseChildrenResult result = Browse(new BrowseChildrenRequest { TagNameGlob = "*Nothing*" });
|
||||||
|
|
||||||
|
Assert.Empty(result.Children);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void DiscoverHierarchy_includes_stripped_ancestors_and_no_other_objects()
|
||||||
|
{
|
||||||
|
GalaxyHierarchyQueryResult result = GalaxyHierarchyProjector.Project(
|
||||||
|
CreateEntry(), new DiscoverHierarchyRequest(), Scope);
|
||||||
|
|
||||||
|
Assert.Equal(
|
||||||
|
new[] { "Plant", "Plant.LineA", "Plant.LineA.Pump01" },
|
||||||
|
result.Objects.Select(o => o.TagName).Order(StringComparer.Ordinal));
|
||||||
|
Assert.Empty(result.Objects.Single(o => o.TagName == "Plant").Attributes);
|
||||||
|
Assert.Empty(result.Objects.Single(o => o.TagName == "Plant.LineA").Attributes);
|
||||||
|
Assert.Single(result.Objects.Single(o => o.TagName == "Plant.LineA.Pump01").Attributes);
|
||||||
|
Assert.Equal(2, result.NavigationAncestorCount);
|
||||||
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public void Unscoped_DiscoverHierarchy_is_unchanged()
|
||||||
|
{
|
||||||
|
GalaxyHierarchyQueryResult result = GalaxyHierarchyProjector.Project(CreateEntry(), new DiscoverHierarchyRequest());
|
||||||
|
|
||||||
|
Assert.Equal(6, result.TotalObjectCount);
|
||||||
|
Assert.Equal(0, result.NavigationAncestorCount);
|
||||||
|
Assert.Single(result.Objects.Single(o => o.TagName == "Plant").Attributes);
|
||||||
|
}
|
||||||
|
|
||||||
|
private static GalaxyBrowseChildrenResult Browse(BrowseChildrenRequest request) =>
|
||||||
|
GalaxyBrowseProjector.ProjectChildren(CreateEntry(), request, Scope, 0, 100);
|
||||||
|
|
||||||
|
private static GalaxyHierarchyCacheEntry CreateEntry()
|
||||||
|
{
|
||||||
|
GalaxyObject[] objects =
|
||||||
|
[
|
||||||
|
Obj(1, 0, "Plant", "Plant", isArea: true),
|
||||||
|
Obj(2, 1, "LineA", "Plant.LineA", isArea: true),
|
||||||
|
Obj(3, 2, "Pump01", "Plant.LineA.Pump01"),
|
||||||
|
Obj(4, 1, "LineB", "Plant.LineB", isArea: true),
|
||||||
|
Obj(5, 4, "Pump02", "Plant.LineB.Pump02"),
|
||||||
|
Obj(6, 1, "Loose", "Plant.Loose"),
|
||||||
|
];
|
||||||
|
return GalaxyHierarchyCacheEntry.Empty with
|
||||||
|
{
|
||||||
|
Status = GalaxyCacheStatus.Healthy,
|
||||||
|
Sequence = 1,
|
||||||
|
LastSuccessAt = DateTimeOffset.UtcNow,
|
||||||
|
Objects = objects,
|
||||||
|
Index = GalaxyHierarchyIndex.Build(objects),
|
||||||
|
ObjectCount = objects.Length,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private static GalaxyObject Obj(int id, int parent, string name, string tag, bool isArea = false)
|
||||||
|
{
|
||||||
|
GalaxyObject obj = new()
|
||||||
|
{
|
||||||
|
GobjectId = id,
|
||||||
|
ParentGobjectId = parent,
|
||||||
|
IsArea = isArea,
|
||||||
|
ContainedName = name,
|
||||||
|
BrowseName = name,
|
||||||
|
TagName = tag,
|
||||||
|
};
|
||||||
|
// Every object, ancestors included, carries an attribute so stripping is observable.
|
||||||
|
obj.Attributes.Add(new GalaxyAttribute { AttributeName = "Secret", FullTagReference = tag + ".Secret" });
|
||||||
|
return obj;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -10,7 +10,7 @@
|
|||||||
| Last reviewed | 2026-11-09 |
|
| Last reviewed | 2026-11-09 |
|
||||||
| Reviewer | Claude |
|
| Reviewer | Claude |
|
||||||
| Commit reviewed | `91fb2b4` |
|
| Commit reviewed | `91fb2b4` |
|
||||||
| Open findings | 7 |
|
| Open findings | 6 |
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
@@ -117,7 +117,7 @@ Resolved 2026-11-09 in the commit tagged `(scadaproj#41)` (GalaxyRepository `0.2
|
|||||||
| Severity | Medium |
|
| Severity | Medium |
|
||||||
| Priority | P2 |
|
| Priority | P2 |
|
||||||
| Category | Correctness & logic bugs |
|
| Category | Correctness & logic bugs |
|
||||||
| Status | Open |
|
| Status | Resolved |
|
||||||
| Location | `ZB.MOM.WW.GalaxyRepository/src/ZB.MOM.WW.GalaxyRepository/GalaxyBrowseProjector.cs:134` (also `ZB.MOM.WW.GalaxyRepository/src/ZB.MOM.WW.GalaxyRepository/GalaxyHierarchyProjector.cs:233`) |
|
| Location | `ZB.MOM.WW.GalaxyRepository/src/ZB.MOM.WW.GalaxyRepository/GalaxyBrowseProjector.cs:134` (also `ZB.MOM.WW.GalaxyRepository/src/ZB.MOM.WW.GalaxyRepository/GalaxyHierarchyProjector.cs:233`) |
|
||||||
|
|
||||||
**Description**
|
**Description**
|
||||||
@@ -162,7 +162,7 @@ a deep scope glob.
|
|||||||
|
|
||||||
**Resolution**
|
**Resolution**
|
||||||
|
|
||||||
_Unresolved._
|
Resolved 2026-11-09 in the commit tagged `(scadaproj#42)` (GalaxyRepository `0.2.1`, unpublished) — an out-of-scope child that has an allowed descendant (also passing the request filters, via the existing `HasMatchingDescendant`) is now returned by `BrowseChildren` as a navigation-only container: `child_has_children = true`, attributes stripped; its other children stay hidden because the same rule applies when it is expanded. `DiscoverHierarchy` likewise returns the out-of-scope ancestors of allowed objects (cycle-safe parent walk; only when inside root/depth and passing the request filters), attribute-stripped, and reports them in the new `GalaxyHierarchyQueryResult.NavigationAncestorCount` init property, which `WatchDeployEvents` subtracts so its scoped counts remain allowed-objects-only. Semantics documented on `IGalaxyBrowseScopeProvider`. Regression tests in `ScopedAncestorBrowseTests` (root browse, ancestor browse, allowed subtree, sibling `LineB` does not leak, filter-gated ancestor, scoped and unscoped `DiscoverHierarchy`); root/ancestor/`DiscoverHierarchy` tests fail without the fix. `GalaxyRepositoryGrpcServiceScopeTests.WatchDeployEvents_ScopedProvider_EmitsFilteredCounts` updated (projection 4 objects incl. 2 ancestors; event still 2). Behaviour change for consumers: a scoped `DiscoverHierarchy` now includes the ancestor objects.
|
||||||
|
|
||||||
### GalaxyRepository-003 — Objects in a parent cycle disappear from `BrowseChildren`
|
### GalaxyRepository-003 — Objects in a parent cycle disappear from `BrowseChildren`
|
||||||
|
|
||||||
|
|||||||
@@ -40,7 +40,7 @@ code-reviews/
|
|||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
10 of 10 libraries reviewed. 45 pending findings across all libraries.
|
10 of 10 libraries reviewed. 44 pending findings across all libraries.
|
||||||
|
|
||||||
Coverage: Secrets, LocalDb, GalaxyRepository and Overview first reviewed, and Auth, Health,
|
Coverage: Secrets, LocalDb, GalaxyRepository and Overview first reviewed, and Auth, Health,
|
||||||
Theme, Audit, Configuration and Telemetry re-reviewed, on 2026-11-09 (#15). Each finding also
|
Theme, Audit, Configuration and Telemetry re-reviewed, on 2026-11-09 (#15). Each finding also
|
||||||
@@ -50,9 +50,9 @@ carries a P1/P2/P3 priority (P1 = Critical/High, P2 = Medium, P3 = Low).
|
|||||||
|----------|---------------|
|
|----------|---------------|
|
||||||
| Critical | 0 |
|
| Critical | 0 |
|
||||||
| High | 0 |
|
| High | 0 |
|
||||||
| Medium | 12 |
|
| Medium | 11 |
|
||||||
| Low | 33 |
|
| Low | 33 |
|
||||||
| **Total** | **45** |
|
| **Total** | **44** |
|
||||||
|
|
||||||
## Library Status
|
## Library Status
|
||||||
|
|
||||||
@@ -61,7 +61,7 @@ carries a P1/P2/P3 priority (P1 = Critical/High, P2 = Medium, P3 = Low).
|
|||||||
| [Audit](Audit/findings.md) | 2026-11-09 | `91fb2b4` | 0/0/0/0 | 0 | 5 |
|
| [Audit](Audit/findings.md) | 2026-11-09 | `91fb2b4` | 0/0/0/0 | 0 | 5 |
|
||||||
| [Auth](Auth/findings.md) | 2026-11-09 | `91fb2b4` | 0/0/1/3 | 4 | 10 |
|
| [Auth](Auth/findings.md) | 2026-11-09 | `91fb2b4` | 0/0/1/3 | 4 | 10 |
|
||||||
| [Configuration](Configuration/findings.md) | 2026-11-09 | `91fb2b4` | 0/0/0/0 | 0 | 4 |
|
| [Configuration](Configuration/findings.md) | 2026-11-09 | `91fb2b4` | 0/0/0/0 | 0 | 4 |
|
||||||
| [GalaxyRepository](GalaxyRepository/findings.md) | 2026-11-09 | `91fb2b4` | 0/0/1/6 | 7 | 8 |
|
| [GalaxyRepository](GalaxyRepository/findings.md) | 2026-11-09 | `91fb2b4` | 0/0/0/6 | 6 | 8 |
|
||||||
| [Health](Health/findings.md) | 2026-11-09 | `91fb2b4` | 0/0/0/1 | 1 | 7 |
|
| [Health](Health/findings.md) | 2026-11-09 | `91fb2b4` | 0/0/0/1 | 1 | 7 |
|
||||||
| [LocalDb](LocalDb/findings.md) | 2026-11-09 | `91fb2b4` | 0/0/4/3 | 7 | 7 |
|
| [LocalDb](LocalDb/findings.md) | 2026-11-09 | `91fb2b4` | 0/0/4/3 | 7 | 7 |
|
||||||
| [Overview](Overview/findings.md) | 2026-11-09 | `91fb2b4` | 0/0/0/3 | 3 | 5 |
|
| [Overview](Overview/findings.md) | 2026-11-09 | `91fb2b4` | 0/0/0/3 | 3 | 5 |
|
||||||
@@ -84,12 +84,11 @@ _None open._
|
|||||||
|
|
||||||
_None open._
|
_None open._
|
||||||
|
|
||||||
### Medium (12)
|
### Medium (11)
|
||||||
|
|
||||||
| ID | Library | Title |
|
| ID | Library | Title |
|
||||||
|----|---------|-------|
|
|----|---------|-------|
|
||||||
| Auth-007 | [Auth](Auth/findings.md) | User-bind mode never checks that the entry whose groups it returns is the account that bound |
|
| Auth-007 | [Auth](Auth/findings.md) | User-bind mode never checks that the entry whose groups it returns is the account that bound |
|
||||||
| GalaxyRepository-002 | [GalaxyRepository](GalaxyRepository/findings.md) | Browse-subtree scoping hides the ancestors of an allowed subtree, so scoped lazy browse from the root is empty |
|
|
||||||
| LocalDb-001 | [LocalDb](LocalDb/findings.md) | Sync endpoint is unauthenticated by default, and `ApiKey` is documented as "expected from the peer" |
|
| LocalDb-001 | [LocalDb](LocalDb/findings.md) | Sync endpoint is unauthenticated by default, and `ApiKey` is documented as "expected from the peer" |
|
||||||
| LocalDb-002 | [LocalDb](LocalDb/findings.md) | Snapshot streams tables by name and rows by `pk_json` text, so FK children land before parents and are dead-lettered for good |
|
| LocalDb-002 | [LocalDb](LocalDb/findings.md) | Snapshot streams tables by name and rows by `pk_json` text, so FK children land before parents and are dead-lettered for good |
|
||||||
| LocalDb-003 | [LocalDb](LocalDb/findings.md) | `INSERT OR REPLACE` apply silently deletes a different row on a secondary `UNIQUE` conflict, so the pair diverges |
|
| LocalDb-003 | [LocalDb](LocalDb/findings.md) | `INSERT OR REPLACE` apply silently deletes a different row on a secondary `UNIQUE` conflict, so the pair diverges |
|
||||||
|
|||||||
Reference in New Issue
Block a user