@fougere/admin 0.6.0-alpha.0 → 0.7.0-alpha.0

package/src/topology.ts

@@ -1,13 +1,4 @@
-/**
- * How the system is arranged, as the app itself reports it.
- *
- * The card answers what a process HOSTS; this answers what SHAPE it is in — which fronds
- * run here, which answered from somewhere else, and who called whom. It is served by
- * `@fougere/observability` on `rpc.topology`, so absence is an ordinary answer: an app
- * that never installed the package has no topology to publish, and says so by refusing
- * the op. Nothing here is declared — a frond is remote because it answered a call nobody
- * hosts, never because a config line said so.
- */
+/** How the system is arranged, as the app itself reports it. */
 import {
   CALL_ENDPOINT,
   fetcher as browserFetcher,
@@ -24,13 +15,7 @@ import {
 
 export type { TopologyReport, FrondPlacement, Edge };
 
-/**
- * The report, or `undefined` when the app serves no topology at all.
- *
- * The refusal is DISTINGUISHED, not swallowed: a `NOT_FOUND` on the op is the package not
- * being wired — something the panel can explain — while anything else is a real failure
- * and stays a failure. One reserved op that is absent must not read as an app that is down.
- */
+/** The report, or `undefined` when the app serves no topology at all. */
 export async function fetchTopology(
   endpoint = CALL_ENDPOINT,
   fetcher: Fetcher = browserFetcher,
@@ -56,13 +41,7 @@ export interface TopologyNode extends FrondPlacement {
   calledBy: Edge[];
 }
 
-/**
- * The report read as a graph, local fronds first.
- *
- * Two passes over `edges` rather than one index per direction: a topology is bounded by
- * fronds², so the whole thing is smaller than one page of rows and an index would be a
- * second structure to keep true.
- */
+/** The report read as a graph, local fronds first. */
 export function nodesOf(report: TopologyReport): TopologyNode[] {
   const order = { local: 0, remote: 1 };
   return [...report.fronds]
@@ -74,14 +53,7 @@ export function nodesOf(report: TopologyReport): TopologyNode[] {
     }));
 }
 
-/**
- * A frond this process called that publishes nothing of its own shape.
- *
- * The honest reading of `entities: 0, doors: 0` on a remote: its shape is published by the
- * process that owns it, under its own service name — so a panel pointed here can say the
- * frond is reachable and cannot say what it holds. Worth naming rather than drawing as an
- * empty frond, which reads as a frond with nothing in it.
- */
+/** A frond this process called that publishes nothing of its own shape. */
 export function isOpaque(node: FrondPlacement): boolean {
   return node.placement === 'remote' && node.entities === 0 && node.doors === 0;
 }