@milaboratories/pl-tree 1.8.47 → 1.8.49

package/dist/sync.d.ts

@@ -1,42 +1,46 @@
-import type { FieldData, PlTransaction, ResourceId } from "@milaboratories/pl-client";
-import type { ExtendedResourceData, PlTreeState } from "./state";
+import { ExtendedResourceData, PlTreeState } from "./state.js";
+import { FieldData, PlTransaction, ResourceId } from "@milaboratories/pl-client";
+
+//#region src/sync.d.ts
 /** Applied to list of fields in resource data. */
-export type PruningFunction = (resource: ExtendedResourceData) => FieldData[];
-export interface TreeLoadingRequest {
-    /** Resource to prime the traversal algorithm. It is ok, if some of them
-     * doesn't exist anymore. Should not contain elements from final resource
-     * set. */
-    readonly seedResources: ResourceId[];
-    /** Resource ids for which state is already known and not expected to change.
-     * Algorithm will not continue traversal over those ids, and states will not
-     * be retrieved for them. */
-    readonly finalResources: Set<ResourceId>;
-    /** This function is applied to each resource data field list, before
-     * using it continue traversal. This modification also is applied to
-     * output data to make result self-consistent in terms that it will contain
-     * all referenced resources, this is required to be able to pass it to tree
-     * to update the state. */
-    readonly pruningFunction?: PruningFunction;
+type PruningFunction = (resource: ExtendedResourceData) => FieldData[];
+interface TreeLoadingRequest {
+  /** Resource to prime the traversal algorithm. It is ok, if some of them
+   * doesn't exist anymore. Should not contain elements from final resource
+   * set. */
+  readonly seedResources: ResourceId[];
+  /** Resource ids for which state is already known and not expected to change.
+   * Algorithm will not continue traversal over those ids, and states will not
+   * be retrieved for them. */
+  readonly finalResources: Set<ResourceId>;
+  /** This function is applied to each resource data field list, before
+   * using it continue traversal. This modification also is applied to
+   * output data to make result self-consistent in terms that it will contain
+   * all referenced resources, this is required to be able to pass it to tree
+   * to update the state. */
+  readonly pruningFunction?: PruningFunction;
 }
 /** Given the current tree state, build the request object to pass to
  * {@link loadTreeState} to load updated state. */
-export declare function constructTreeLoadingRequest(tree: PlTreeState, pruningFunction?: PruningFunction): TreeLoadingRequest;
-export type TreeLoadingStat = {
-    requests: number;
-    roundTrips: number;
-    retrievedResources: number;
-    retrievedFields: number;
-    retrievedKeyValues: number;
-    retrievedResourceDataBytes: number;
-    retrievedKeyValueBytes: number;
-    prunedFields: number;
-    finalResourcesSkipped: number;
-    millisSpent: number;
+declare function constructTreeLoadingRequest(tree: PlTreeState, pruningFunction?: PruningFunction): TreeLoadingRequest;
+type TreeLoadingStat = {
+  requests: number;
+  roundTrips: number;
+  retrievedResources: number;
+  retrievedFields: number;
+  retrievedKeyValues: number;
+  retrievedResourceDataBytes: number;
+  retrievedKeyValueBytes: number;
+  prunedFields: number;
+  finalResourcesSkipped: number;
+  millisSpent: number;
 };
-export declare function initialTreeLoadingStat(): TreeLoadingStat;
-export declare function formatTreeLoadingStat(stat: TreeLoadingStat): string;
+declare function initialTreeLoadingStat(): TreeLoadingStat;
+declare function formatTreeLoadingStat(stat: TreeLoadingStat): string;
 /** Given the transaction (preferably read-only) and loading request, executes
  * the tree traversal algorithm, and collects fresh states of resources
  * to update the tree state. */
-export declare function loadTreeState(tx: PlTransaction, loadingRequest: TreeLoadingRequest, stats?: TreeLoadingStat): Promise<ExtendedResourceData[]>;
+declare function loadTreeState(tx: PlTransaction, loadingRequest: TreeLoadingRequest, stats?: TreeLoadingStat): Promise<ExtendedResourceData[]>;
+//#endregion
+export { PruningFunction, TreeLoadingRequest, TreeLoadingStat, constructTreeLoadingRequest, formatTreeLoadingStat, initialTreeLoadingStat, loadTreeState };
 //# sourceMappingURL=sync.d.ts.map

package/dist/sync.js

@@ -1,144 +1,124 @@
-import Denque from 'denque';
-import { isNullResourceId } from '@milaboratories/pl-client';
-import { msToHumanReadable, ConcurrencyLimitingExecutor } from '@milaboratories/ts-helpers';
+import { isNullResourceId } from "@milaboratories/pl-client";
+import { ConcurrencyLimitingExecutor, msToHumanReadable } from "@milaboratories/ts-helpers";
+import Denque from "denque";
 
+//#region src/sync.ts
 /** Given the current tree state, build the request object to pass to
- * {@link loadTreeState} to load updated state. */
+* {@link loadTreeState} to load updated state. */
 function constructTreeLoadingRequest(tree, pruningFunction) {
-    const seedResources = [];
-    const finalResources = new Set();
-    tree.forEachResource((res) => {
-        if (res.finalState)
-            finalResources.add(res.id);
-        else
-            seedResources.push(res.id);
-    });
-    // if tree is empty, seeding tree reconstruction from the specified root
-    if (seedResources.length === 0 && finalResources.size === 0)
-        seedResources.push(tree.root);
-    return { seedResources, finalResources, pruningFunction };
+	const seedResources = [];
+	const finalResources = /* @__PURE__ */ new Set();
+	tree.forEachResource((res) => {
+		if (res.finalState) finalResources.add(res.id);
+		else seedResources.push(res.id);
+	});
+	if (seedResources.length === 0 && finalResources.size === 0) seedResources.push(tree.root);
+	return {
+		seedResources,
+		finalResources,
+		pruningFunction
+	};
 }
 function initialTreeLoadingStat() {
-    return {
-        requests: 0,
-        roundTrips: 0,
-        retrievedResources: 0,
-        retrievedFields: 0,
-        retrievedKeyValues: 0,
-        retrievedResourceDataBytes: 0,
-        retrievedKeyValueBytes: 0,
-        prunedFields: 0,
-        finalResourcesSkipped: 0,
-        millisSpent: 0,
-    };
+	return {
+		requests: 0,
+		roundTrips: 0,
+		retrievedResources: 0,
+		retrievedFields: 0,
+		retrievedKeyValues: 0,
+		retrievedResourceDataBytes: 0,
+		retrievedKeyValueBytes: 0,
+		prunedFields: 0,
+		finalResourcesSkipped: 0,
+		millisSpent: 0
+	};
 }
 function formatTreeLoadingStat(stat) {
-    let result = `Requests: ${stat.requests}\n`;
-    result += `Total time: ${msToHumanReadable(stat.millisSpent)}\n`;
-    result += `Round-trips: ${stat.roundTrips}\n`;
-    result += `Resources: ${stat.retrievedResources}\n`;
-    result += `Fields: ${stat.retrievedFields}\n`;
-    result += `KV: ${stat.retrievedKeyValues}\n`;
-    result += `Data Bytes: ${stat.retrievedResourceDataBytes}\n`;
-    result += `KV Bytes: ${stat.retrievedKeyValueBytes}\n`;
-    result += `Pruned fields: ${stat.prunedFields}\n`;
-    result += `Final resources skipped: ${stat.finalResourcesSkipped}`;
-    return result;
+	let result = `Requests: ${stat.requests}\n`;
+	result += `Total time: ${msToHumanReadable(stat.millisSpent)}\n`;
+	result += `Round-trips: ${stat.roundTrips}\n`;
+	result += `Resources: ${stat.retrievedResources}\n`;
+	result += `Fields: ${stat.retrievedFields}\n`;
+	result += `KV: ${stat.retrievedKeyValues}\n`;
+	result += `Data Bytes: ${stat.retrievedResourceDataBytes}\n`;
+	result += `KV Bytes: ${stat.retrievedKeyValueBytes}\n`;
+	result += `Pruned fields: ${stat.prunedFields}\n`;
+	result += `Final resources skipped: ${stat.finalResourcesSkipped}`;
+	return result;
 }
 /** Given the transaction (preferably read-only) and loading request, executes
- * the tree traversal algorithm, and collects fresh states of resources
- * to update the tree state. */
+* the tree traversal algorithm, and collects fresh states of resources
+* to update the tree state. */
 async function loadTreeState(tx, loadingRequest, stats) {
-    // saving start timestamp to add time spent in this function to the stats at the end of the method
-    const startTimestamp = Date.now();
-    // counting the request
-    if (stats)
-        stats.requests++;
-    const { seedResources, finalResources, pruningFunction } = loadingRequest;
-    // Limits the number of concurrent gRPC fetches to bound peak memory
-    // from in-flight request/response buffers.
-    const limiter = new ConcurrencyLimitingExecutor(100);
-    // Promises of resource states, in the order they were requested.
-    const pending = new Denque();
-    // vars to calculate number of roundtrips for stats
-    let roundTripToggle = true;
-    let numberOfRoundTrips = 0;
-    // tracking resources we already requested or queued
-    const requested = new Set();
-    /** Mark a resource for fetching. Deduplicates and respects final-resource set. */
-    const requestState = (rid) => {
-        if (isNullResourceId(rid) || requested.has(rid))
-            return;
-        if (finalResources.has(rid)) {
-            if (stats)
-                stats.finalResourcesSkipped++;
-            return;
-        }
-        requested.add(rid);
-        pending.push(limiter.run(async () => {
-            const resourceData = tx.getResourceDataIfExists(rid, true);
-            const kvData = tx.listKeyValuesIfResourceExists(rid);
-            // counting round-trip (begin)
-            const addRT = roundTripToggle;
-            if (roundTripToggle)
-                roundTripToggle = false;
-            const [resource, kv] = await Promise.all([resourceData, kvData]);
-            // counting round-trip, actually incrementing counter and returning toggle back,
-            // so the next request can acquire it
-            if (addRT) {
-                numberOfRoundTrips++;
-                roundTripToggle = true;
-            }
-            if (resource === undefined)
-                return undefined;
-            if (kv === undefined)
-                throw new Error("Inconsistent replies");
-            return { ...resource, kv };
-        }));
-    };
-    // sending seed requests
-    seedResources.forEach((rid) => requestState(rid));
-    const result = [];
-    let nextPromise;
-    while ((nextPromise = pending.shift()) !== undefined) {
-        // at this point we pause and wait for the next requested resource state to arrive
-        let nextResource = await nextPromise;
-        if (nextResource === undefined)
-            // ignoring resources that were not found (this may happen for seed resource ids)
-            continue;
-        if (pruningFunction !== undefined) {
-            // apply field pruning, if requested
-            const fieldsAfterPruning = pruningFunction(nextResource);
-            // collecting stats
-            if (stats)
-                stats.prunedFields += nextResource.fields.length - fieldsAfterPruning.length;
-            nextResource = { ...nextResource, fields: fieldsAfterPruning };
-        }
-        // continue traversal over the referenced resources
-        requestState(nextResource.error);
-        for (const field of nextResource.fields) {
-            requestState(field.value);
-            requestState(field.error);
-        }
-        // collecting stats
-        if (stats) {
-            stats.retrievedResources++;
-            stats.retrievedFields += nextResource.fields.length;
-            stats.retrievedKeyValues += nextResource.kv.length;
-            stats.retrievedResourceDataBytes += nextResource.data?.length ?? 0;
-            for (const kv of nextResource.kv)
-                stats.retrievedKeyValueBytes += kv.value.length;
-        }
-        // aggregating the state
-        result.push(nextResource);
-    }
-    // adding the time we spent in this method to stats
-    if (stats) {
-        stats.millisSpent += Date.now() - startTimestamp;
-        stats.roundTrips += numberOfRoundTrips;
-    }
-    return result;
+	const startTimestamp = Date.now();
+	if (stats) stats.requests++;
+	const { seedResources, finalResources, pruningFunction } = loadingRequest;
+	const limiter = new ConcurrencyLimitingExecutor(100);
+	const pending = new Denque();
+	let roundTripToggle = true;
+	let numberOfRoundTrips = 0;
+	const requested = /* @__PURE__ */ new Set();
+	/** Mark a resource for fetching. Deduplicates and respects final-resource set. */
+	const requestState = (rid) => {
+		if (isNullResourceId(rid) || requested.has(rid)) return;
+		if (finalResources.has(rid)) {
+			if (stats) stats.finalResourcesSkipped++;
+			return;
+		}
+		requested.add(rid);
+		pending.push(limiter.run(async () => {
+			const resourceData = tx.getResourceDataIfExists(rid, true);
+			const kvData = tx.listKeyValuesIfResourceExists(rid);
+			const addRT = roundTripToggle;
+			if (roundTripToggle) roundTripToggle = false;
+			const [resource, kv] = await Promise.all([resourceData, kvData]);
+			if (addRT) {
+				numberOfRoundTrips++;
+				roundTripToggle = true;
+			}
+			if (resource === void 0) return void 0;
+			if (kv === void 0) throw new Error("Inconsistent replies");
+			return {
+				...resource,
+				kv
+			};
+		}));
+	};
+	seedResources.forEach((rid) => requestState(rid));
+	const result = [];
+	let nextPromise;
+	while ((nextPromise = pending.shift()) !== void 0) {
+		let nextResource = await nextPromise;
+		if (nextResource === void 0) continue;
+		if (pruningFunction !== void 0) {
+			const fieldsAfterPruning = pruningFunction(nextResource);
+			if (stats) stats.prunedFields += nextResource.fields.length - fieldsAfterPruning.length;
+			nextResource = {
+				...nextResource,
+				fields: fieldsAfterPruning
+			};
+		}
+		requestState(nextResource.error);
+		for (const field of nextResource.fields) {
+			requestState(field.value);
+			requestState(field.error);
+		}
+		if (stats) {
+			stats.retrievedResources++;
+			stats.retrievedFields += nextResource.fields.length;
+			stats.retrievedKeyValues += nextResource.kv.length;
+			stats.retrievedResourceDataBytes += nextResource.data?.length ?? 0;
+			for (const kv of nextResource.kv) stats.retrievedKeyValueBytes += kv.value.length;
+		}
+		result.push(nextResource);
+	}
+	if (stats) {
+		stats.millisSpent += Date.now() - startTimestamp;
+		stats.roundTrips += numberOfRoundTrips;
+	}
+	return result;
 }
 
+//#endregion
 export { constructTreeLoadingRequest, formatTreeLoadingStat, initialTreeLoadingStat, loadTreeState };
-//# sourceMappingURL=sync.js.map
+//# sourceMappingURL=sync.js.map

package/dist/sync.js.map

@@ -1 +1 @@
-{"version":3,"file":"sync.js","sources":["../src/sync.ts"],"sourcesContent":["import type {\n  FieldData,\n  OptionalResourceId,\n  PlTransaction,\n  ResourceId,\n} from \"@milaboratories/pl-client\";\nimport Denque from \"denque\";\nimport { isNullResourceId } from \"@milaboratories/pl-client\";\nimport type { ExtendedResourceData, PlTreeState } from \"./state\";\nimport { ConcurrencyLimitingExecutor, msToHumanReadable } from \"@milaboratories/ts-helpers\";\n\n/** Applied to list of fields in resource data. */\nexport type PruningFunction = (resource: ExtendedResourceData) => FieldData[];\n\nexport interface TreeLoadingRequest {\n  /** Resource to prime the traversal algorithm. It is ok, if some of them\n   * doesn't exist anymore. Should not contain elements from final resource\n   * set. */\n  readonly seedResources: ResourceId[];\n\n  /** Resource ids for which state is already known and not expected to change.\n   * Algorithm will not continue traversal over those ids, and states will not\n   * be retrieved for them. */\n  readonly finalResources: Set<ResourceId>;\n\n  /** This function is applied to each resource data field list, before\n   * using it continue traversal. This modification also is applied to\n   * output data to make result self-consistent in terms that it will contain\n   * all referenced resources, this is required to be able to pass it to tree\n   * to update the state. */\n  readonly pruningFunction?: PruningFunction;\n}\n\n/** Given the current tree state, build the request object to pass to\n * {@link loadTreeState} to load updated state. */\nexport function constructTreeLoadingRequest(\n  tree: PlTreeState,\n  pruningFunction?: PruningFunction,\n): TreeLoadingRequest {\n  const seedResources: ResourceId[] = [];\n  const finalResources = new Set<ResourceId>();\n  tree.forEachResource((res) => {\n    if (res.finalState) finalResources.add(res.id);\n    else seedResources.push(res.id);\n  });\n\n  // if tree is empty, seeding tree reconstruction from the specified root\n  if (seedResources.length === 0 && finalResources.size === 0) seedResources.push(tree.root);\n\n  return { seedResources, finalResources, pruningFunction };\n}\n\nexport type TreeLoadingStat = {\n  requests: number;\n  roundTrips: number;\n  retrievedResources: number;\n  retrievedFields: number;\n  retrievedKeyValues: number;\n  retrievedResourceDataBytes: number;\n  retrievedKeyValueBytes: number;\n  prunedFields: number;\n  finalResourcesSkipped: number;\n  millisSpent: number;\n};\n\nexport function initialTreeLoadingStat(): TreeLoadingStat {\n  return {\n    requests: 0,\n    roundTrips: 0,\n    retrievedResources: 0,\n    retrievedFields: 0,\n    retrievedKeyValues: 0,\n    retrievedResourceDataBytes: 0,\n    retrievedKeyValueBytes: 0,\n    prunedFields: 0,\n    finalResourcesSkipped: 0,\n    millisSpent: 0,\n  };\n}\n\nexport function formatTreeLoadingStat(stat: TreeLoadingStat): string {\n  let result = `Requests: ${stat.requests}\\n`;\n  result += `Total time: ${msToHumanReadable(stat.millisSpent)}\\n`;\n  result += `Round-trips: ${stat.roundTrips}\\n`;\n  result += `Resources: ${stat.retrievedResources}\\n`;\n  result += `Fields: ${stat.retrievedFields}\\n`;\n  result += `KV: ${stat.retrievedKeyValues}\\n`;\n  result += `Data Bytes: ${stat.retrievedResourceDataBytes}\\n`;\n  result += `KV Bytes: ${stat.retrievedKeyValueBytes}\\n`;\n  result += `Pruned fields: ${stat.prunedFields}\\n`;\n  result += `Final resources skipped: ${stat.finalResourcesSkipped}`;\n  return result;\n}\n\n/** Given the transaction (preferably read-only) and loading request, executes\n * the tree traversal algorithm, and collects fresh states of resources\n * to update the tree state. */\nexport async function loadTreeState(\n  tx: PlTransaction,\n  loadingRequest: TreeLoadingRequest,\n  stats?: TreeLoadingStat,\n): Promise<ExtendedResourceData[]> {\n  // saving start timestamp to add time spent in this function to the stats at the end of the method\n  const startTimestamp = Date.now();\n\n  // counting the request\n  if (stats) stats.requests++;\n\n  const { seedResources, finalResources, pruningFunction } = loadingRequest;\n\n  // Limits the number of concurrent gRPC fetches to bound peak memory\n  // from in-flight request/response buffers.\n  const limiter = new ConcurrencyLimitingExecutor(100);\n\n  // Promises of resource states, in the order they were requested.\n  const pending = new Denque<Promise<ExtendedResourceData | undefined>>();\n\n  // vars to calculate number of roundtrips for stats\n  let roundTripToggle: boolean = true;\n  let numberOfRoundTrips = 0;\n\n  // tracking resources we already requested or queued\n  const requested = new Set<ResourceId>();\n\n  /** Mark a resource for fetching. Deduplicates and respects final-resource set. */\n  const requestState = (rid: OptionalResourceId) => {\n    if (isNullResourceId(rid) || requested.has(rid)) return;\n\n    if (finalResources.has(rid)) {\n      if (stats) stats.finalResourcesSkipped++;\n      return;\n    }\n\n    requested.add(rid);\n\n    pending.push(\n      limiter.run(async () => {\n        const resourceData = tx.getResourceDataIfExists(rid, true);\n        const kvData = tx.listKeyValuesIfResourceExists(rid);\n\n        // counting round-trip (begin)\n        const addRT = roundTripToggle;\n        if (roundTripToggle) roundTripToggle = false;\n\n        const [resource, kv] = await Promise.all([resourceData, kvData]);\n\n        // counting round-trip, actually incrementing counter and returning toggle back,\n        // so the next request can acquire it\n        if (addRT) {\n          numberOfRoundTrips++;\n          roundTripToggle = true;\n        }\n\n        if (resource === undefined) return undefined;\n        if (kv === undefined) throw new Error(\"Inconsistent replies\");\n\n        return { ...resource, kv };\n      }),\n    );\n  };\n\n  // sending seed requests\n  seedResources.forEach((rid) => requestState(rid));\n\n  const result: ExtendedResourceData[] = [];\n  let nextPromise: Promise<ExtendedResourceData | undefined> | undefined;\n  while ((nextPromise = pending.shift()) !== undefined) {\n    // at this point we pause and wait for the next requested resource state to arrive\n    let nextResource = await nextPromise;\n    if (nextResource === undefined)\n      // ignoring resources that were not found (this may happen for seed resource ids)\n      continue;\n\n    if (pruningFunction !== undefined) {\n      // apply field pruning, if requested\n      const fieldsAfterPruning = pruningFunction(nextResource);\n      // collecting stats\n      if (stats) stats.prunedFields += nextResource.fields.length - fieldsAfterPruning.length;\n      nextResource = { ...nextResource, fields: fieldsAfterPruning };\n    }\n\n    // continue traversal over the referenced resources\n    requestState(nextResource.error);\n    for (const field of nextResource.fields) {\n      requestState(field.value);\n      requestState(field.error);\n    }\n\n    // collecting stats\n    if (stats) {\n      stats.retrievedResources++;\n      stats.retrievedFields += nextResource.fields.length;\n      stats.retrievedKeyValues += nextResource.kv.length;\n      stats.retrievedResourceDataBytes += nextResource.data?.length ?? 0;\n      for (const kv of nextResource.kv) stats.retrievedKeyValueBytes += kv.value.length;\n    }\n\n    // aggregating the state\n    result.push(nextResource);\n  }\n\n  // adding the time we spent in this method to stats\n  if (stats) {\n    stats.millisSpent += Date.now() - startTimestamp;\n    stats.roundTrips += numberOfRoundTrips;\n  }\n\n  return result;\n}\n"],"names":[],"mappings":";;;;AAiCA;AACkD;AAC5C,SAAU,2BAA2B,CACzC,IAAiB,EACjB,eAAiC,EAAA;IAEjC,MAAM,aAAa,GAAiB,EAAE;AACtC,IAAA,MAAM,cAAc,GAAG,IAAI,GAAG,EAAc;AAC5C,IAAA,IAAI,CAAC,eAAe,CAAC,CAAC,GAAG,KAAI;QAC3B,IAAI,GAAG,CAAC,UAAU;AAAE,YAAA,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;;AACzC,YAAA,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;AACjC,IAAA,CAAC,CAAC;;IAGF,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,CAAC;AAAE,QAAA,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AAE1F,IAAA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE;AAC3D;SAegB,sBAAsB,GAAA;IACpC,OAAO;AACL,QAAA,QAAQ,EAAE,CAAC;AACX,QAAA,UAAU,EAAE,CAAC;AACb,QAAA,kBAAkB,EAAE,CAAC;AACrB,QAAA,eAAe,EAAE,CAAC;AAClB,QAAA,kBAAkB,EAAE,CAAC;AACrB,QAAA,0BAA0B,EAAE,CAAC;AAC7B,QAAA,sBAAsB,EAAE,CAAC;AACzB,QAAA,YAAY,EAAE,CAAC;AACf,QAAA,qBAAqB,EAAE,CAAC;AACxB,QAAA,WAAW,EAAE,CAAC;KACf;AACH;AAEM,SAAU,qBAAqB,CAAC,IAAqB,EAAA;AACzD,IAAA,IAAI,MAAM,GAAG,CAAA,UAAA,EAAa,IAAI,CAAC,QAAQ,IAAI;IAC3C,MAAM,IAAI,eAAe,iBAAiB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA,EAAA,CAAI;AAChE,IAAA,MAAM,IAAI,CAAA,aAAA,EAAgB,IAAI,CAAC,UAAU,IAAI;AAC7C,IAAA,MAAM,IAAI,CAAA,WAAA,EAAc,IAAI,CAAC,kBAAkB,IAAI;AACnD,IAAA,MAAM,IAAI,CAAA,QAAA,EAAW,IAAI,CAAC,eAAe,IAAI;AAC7C,IAAA,MAAM,IAAI,CAAA,IAAA,EAAO,IAAI,CAAC,kBAAkB,IAAI;AAC5C,IAAA,MAAM,IAAI,CAAA,YAAA,EAAe,IAAI,CAAC,0BAA0B,IAAI;AAC5D,IAAA,MAAM,IAAI,CAAA,UAAA,EAAa,IAAI,CAAC,sBAAsB,IAAI;AACtD,IAAA,MAAM,IAAI,CAAA,eAAA,EAAkB,IAAI,CAAC,YAAY,IAAI;AACjD,IAAA,MAAM,IAAI,CAAA,yBAAA,EAA4B,IAAI,CAAC,qBAAqB,EAAE;AAClE,IAAA,OAAO,MAAM;AACf;AAEA;;AAE+B;AACxB,eAAe,aAAa,CACjC,EAAiB,EACjB,cAAkC,EAClC,KAAuB,EAAA;;AAGvB,IAAA,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE;;AAGjC,IAAA,IAAI,KAAK;QAAE,KAAK,CAAC,QAAQ,EAAE;IAE3B,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,GAAG,cAAc;;;AAIzE,IAAA,MAAM,OAAO,GAAG,IAAI,2BAA2B,CAAC,GAAG,CAAC;;AAGpD,IAAA,MAAM,OAAO,GAAG,IAAI,MAAM,EAA6C;;IAGvE,IAAI,eAAe,GAAY,IAAI;IACnC,IAAI,kBAAkB,GAAG,CAAC;;AAG1B,IAAA,MAAM,SAAS,GAAG,IAAI,GAAG,EAAc;;AAGvC,IAAA,MAAM,YAAY,GAAG,CAAC,GAAuB,KAAI;QAC/C,IAAI,gBAAgB,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE;AAEjD,QAAA,IAAI,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;AAC3B,YAAA,IAAI,KAAK;gBAAE,KAAK,CAAC,qBAAqB,EAAE;YACxC;QACF;AAEA,QAAA,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC;QAElB,OAAO,CAAC,IAAI,CACV,OAAO,CAAC,GAAG,CAAC,YAAW;YACrB,MAAM,YAAY,GAAG,EAAE,CAAC,uBAAuB,CAAC,GAAG,EAAE,IAAI,CAAC;YAC1D,MAAM,MAAM,GAAG,EAAE,CAAC,6BAA6B,CAAC,GAAG,CAAC;;YAGpD,MAAM,KAAK,GAAG,eAAe;AAC7B,YAAA,IAAI,eAAe;gBAAE,eAAe,GAAG,KAAK;AAE5C,YAAA,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;;;YAIhE,IAAI,KAAK,EAAE;AACT,gBAAA,kBAAkB,EAAE;gBACpB,eAAe,GAAG,IAAI;YACxB;YAEA,IAAI,QAAQ,KAAK,SAAS;AAAE,gBAAA,OAAO,SAAS;YAC5C,IAAI,EAAE,KAAK,SAAS;AAAE,gBAAA,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC;AAE7D,YAAA,OAAO,EAAE,GAAG,QAAQ,EAAE,EAAE,EAAE;QAC5B,CAAC,CAAC,CACH;AACH,IAAA,CAAC;;AAGD,IAAA,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,KAAK,YAAY,CAAC,GAAG,CAAC,CAAC;IAEjD,MAAM,MAAM,GAA2B,EAAE;AACzC,IAAA,IAAI,WAAkE;IACtE,OAAO,CAAC,WAAW,GAAG,OAAO,CAAC,KAAK,EAAE,MAAM,SAAS,EAAE;;AAEpD,QAAA,IAAI,YAAY,GAAG,MAAM,WAAW;QACpC,IAAI,YAAY,KAAK,SAAS;;YAE5B;AAEF,QAAA,IAAI,eAAe,KAAK,SAAS,EAAE;;AAEjC,YAAA,MAAM,kBAAkB,GAAG,eAAe,CAAC,YAAY,CAAC;;AAExD,YAAA,IAAI,KAAK;AAAE,gBAAA,KAAK,CAAC,YAAY,IAAI,YAAY,CAAC,MAAM,CAAC,MAAM,GAAG,kBAAkB,CAAC,MAAM;YACvF,YAAY,GAAG,EAAE,GAAG,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE;QAChE;;AAGA,QAAA,YAAY,CAAC,YAAY,CAAC,KAAK,CAAC;AAChC,QAAA,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,MAAM,EAAE;AACvC,YAAA,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC;AACzB,YAAA,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC;QAC3B;;QAGA,IAAI,KAAK,EAAE;YACT,KAAK,CAAC,kBAAkB,EAAE;YAC1B,KAAK,CAAC,eAAe,IAAI,YAAY,CAAC,MAAM,CAAC,MAAM;YACnD,KAAK,CAAC,kBAAkB,IAAI,YAAY,CAAC,EAAE,CAAC,MAAM;YAClD,KAAK,CAAC,0BAA0B,IAAI,YAAY,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC;AAClE,YAAA,KAAK,MAAM,EAAE,IAAI,YAAY,CAAC,EAAE;gBAAE,KAAK,CAAC,sBAAsB,IAAI,EAAE,CAAC,KAAK,CAAC,MAAM;QACnF;;AAGA,QAAA,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC;IAC3B;;IAGA,IAAI,KAAK,EAAE;QACT,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,cAAc;AAChD,QAAA,KAAK,CAAC,UAAU,IAAI,kBAAkB;IACxC;AAEA,IAAA,OAAO,MAAM;AACf;;;;"}
+{"version":3,"file":"sync.js","names":[],"sources":["../src/sync.ts"],"sourcesContent":["import type {\n  FieldData,\n  OptionalResourceId,\n  PlTransaction,\n  ResourceId,\n} from \"@milaboratories/pl-client\";\nimport Denque from \"denque\";\nimport { isNullResourceId } from \"@milaboratories/pl-client\";\nimport type { ExtendedResourceData, PlTreeState } from \"./state\";\nimport { ConcurrencyLimitingExecutor, msToHumanReadable } from \"@milaboratories/ts-helpers\";\n\n/** Applied to list of fields in resource data. */\nexport type PruningFunction = (resource: ExtendedResourceData) => FieldData[];\n\nexport interface TreeLoadingRequest {\n  /** Resource to prime the traversal algorithm. It is ok, if some of them\n   * doesn't exist anymore. Should not contain elements from final resource\n   * set. */\n  readonly seedResources: ResourceId[];\n\n  /** Resource ids for which state is already known and not expected to change.\n   * Algorithm will not continue traversal over those ids, and states will not\n   * be retrieved for them. */\n  readonly finalResources: Set<ResourceId>;\n\n  /** This function is applied to each resource data field list, before\n   * using it continue traversal. This modification also is applied to\n   * output data to make result self-consistent in terms that it will contain\n   * all referenced resources, this is required to be able to pass it to tree\n   * to update the state. */\n  readonly pruningFunction?: PruningFunction;\n}\n\n/** Given the current tree state, build the request object to pass to\n * {@link loadTreeState} to load updated state. */\nexport function constructTreeLoadingRequest(\n  tree: PlTreeState,\n  pruningFunction?: PruningFunction,\n): TreeLoadingRequest {\n  const seedResources: ResourceId[] = [];\n  const finalResources = new Set<ResourceId>();\n  tree.forEachResource((res) => {\n    if (res.finalState) finalResources.add(res.id);\n    else seedResources.push(res.id);\n  });\n\n  // if tree is empty, seeding tree reconstruction from the specified root\n  if (seedResources.length === 0 && finalResources.size === 0) seedResources.push(tree.root);\n\n  return { seedResources, finalResources, pruningFunction };\n}\n\nexport type TreeLoadingStat = {\n  requests: number;\n  roundTrips: number;\n  retrievedResources: number;\n  retrievedFields: number;\n  retrievedKeyValues: number;\n  retrievedResourceDataBytes: number;\n  retrievedKeyValueBytes: number;\n  prunedFields: number;\n  finalResourcesSkipped: number;\n  millisSpent: number;\n};\n\nexport function initialTreeLoadingStat(): TreeLoadingStat {\n  return {\n    requests: 0,\n    roundTrips: 0,\n    retrievedResources: 0,\n    retrievedFields: 0,\n    retrievedKeyValues: 0,\n    retrievedResourceDataBytes: 0,\n    retrievedKeyValueBytes: 0,\n    prunedFields: 0,\n    finalResourcesSkipped: 0,\n    millisSpent: 0,\n  };\n}\n\nexport function formatTreeLoadingStat(stat: TreeLoadingStat): string {\n  let result = `Requests: ${stat.requests}\\n`;\n  result += `Total time: ${msToHumanReadable(stat.millisSpent)}\\n`;\n  result += `Round-trips: ${stat.roundTrips}\\n`;\n  result += `Resources: ${stat.retrievedResources}\\n`;\n  result += `Fields: ${stat.retrievedFields}\\n`;\n  result += `KV: ${stat.retrievedKeyValues}\\n`;\n  result += `Data Bytes: ${stat.retrievedResourceDataBytes}\\n`;\n  result += `KV Bytes: ${stat.retrievedKeyValueBytes}\\n`;\n  result += `Pruned fields: ${stat.prunedFields}\\n`;\n  result += `Final resources skipped: ${stat.finalResourcesSkipped}`;\n  return result;\n}\n\n/** Given the transaction (preferably read-only) and loading request, executes\n * the tree traversal algorithm, and collects fresh states of resources\n * to update the tree state. */\nexport async function loadTreeState(\n  tx: PlTransaction,\n  loadingRequest: TreeLoadingRequest,\n  stats?: TreeLoadingStat,\n): Promise<ExtendedResourceData[]> {\n  // saving start timestamp to add time spent in this function to the stats at the end of the method\n  const startTimestamp = Date.now();\n\n  // counting the request\n  if (stats) stats.requests++;\n\n  const { seedResources, finalResources, pruningFunction } = loadingRequest;\n\n  // Limits the number of concurrent gRPC fetches to bound peak memory\n  // from in-flight request/response buffers.\n  const limiter = new ConcurrencyLimitingExecutor(100);\n\n  // Promises of resource states, in the order they were requested.\n  const pending = new Denque<Promise<ExtendedResourceData | undefined>>();\n\n  // vars to calculate number of roundtrips for stats\n  let roundTripToggle: boolean = true;\n  let numberOfRoundTrips = 0;\n\n  // tracking resources we already requested or queued\n  const requested = new Set<ResourceId>();\n\n  /** Mark a resource for fetching. Deduplicates and respects final-resource set. */\n  const requestState = (rid: OptionalResourceId) => {\n    if (isNullResourceId(rid) || requested.has(rid)) return;\n\n    if (finalResources.has(rid)) {\n      if (stats) stats.finalResourcesSkipped++;\n      return;\n    }\n\n    requested.add(rid);\n\n    pending.push(\n      limiter.run(async () => {\n        const resourceData = tx.getResourceDataIfExists(rid, true);\n        const kvData = tx.listKeyValuesIfResourceExists(rid);\n\n        // counting round-trip (begin)\n        const addRT = roundTripToggle;\n        if (roundTripToggle) roundTripToggle = false;\n\n        const [resource, kv] = await Promise.all([resourceData, kvData]);\n\n        // counting round-trip, actually incrementing counter and returning toggle back,\n        // so the next request can acquire it\n        if (addRT) {\n          numberOfRoundTrips++;\n          roundTripToggle = true;\n        }\n\n        if (resource === undefined) return undefined;\n        if (kv === undefined) throw new Error(\"Inconsistent replies\");\n\n        return { ...resource, kv };\n      }),\n    );\n  };\n\n  // sending seed requests\n  seedResources.forEach((rid) => requestState(rid));\n\n  const result: ExtendedResourceData[] = [];\n  let nextPromise: Promise<ExtendedResourceData | undefined> | undefined;\n  while ((nextPromise = pending.shift()) !== undefined) {\n    // at this point we pause and wait for the next requested resource state to arrive\n    let nextResource = await nextPromise;\n    if (nextResource === undefined)\n      // ignoring resources that were not found (this may happen for seed resource ids)\n      continue;\n\n    if (pruningFunction !== undefined) {\n      // apply field pruning, if requested\n      const fieldsAfterPruning = pruningFunction(nextResource);\n      // collecting stats\n      if (stats) stats.prunedFields += nextResource.fields.length - fieldsAfterPruning.length;\n      nextResource = { ...nextResource, fields: fieldsAfterPruning };\n    }\n\n    // continue traversal over the referenced resources\n    requestState(nextResource.error);\n    for (const field of nextResource.fields) {\n      requestState(field.value);\n      requestState(field.error);\n    }\n\n    // collecting stats\n    if (stats) {\n      stats.retrievedResources++;\n      stats.retrievedFields += nextResource.fields.length;\n      stats.retrievedKeyValues += nextResource.kv.length;\n      stats.retrievedResourceDataBytes += nextResource.data?.length ?? 0;\n      for (const kv of nextResource.kv) stats.retrievedKeyValueBytes += kv.value.length;\n    }\n\n    // aggregating the state\n    result.push(nextResource);\n  }\n\n  // adding the time we spent in this method to stats\n  if (stats) {\n    stats.millisSpent += Date.now() - startTimestamp;\n    stats.roundTrips += numberOfRoundTrips;\n  }\n\n  return result;\n}\n"],"mappings":";;;;;;;AAmCA,SAAgB,4BACd,MACA,iBACoB;CACpB,MAAM,gBAA8B,EAAE;CACtC,MAAM,iCAAiB,IAAI,KAAiB;AAC5C,MAAK,iBAAiB,QAAQ;AAC5B,MAAI,IAAI,WAAY,gBAAe,IAAI,IAAI,GAAG;MACzC,eAAc,KAAK,IAAI,GAAG;GAC/B;AAGF,KAAI,cAAc,WAAW,KAAK,eAAe,SAAS,EAAG,eAAc,KAAK,KAAK,KAAK;AAE1F,QAAO;EAAE;EAAe;EAAgB;EAAiB;;AAgB3D,SAAgB,yBAA0C;AACxD,QAAO;EACL,UAAU;EACV,YAAY;EACZ,oBAAoB;EACpB,iBAAiB;EACjB,oBAAoB;EACpB,4BAA4B;EAC5B,wBAAwB;EACxB,cAAc;EACd,uBAAuB;EACvB,aAAa;EACd;;AAGH,SAAgB,sBAAsB,MAA+B;CACnE,IAAI,SAAS,aAAa,KAAK,SAAS;AACxC,WAAU,eAAe,kBAAkB,KAAK,YAAY,CAAC;AAC7D,WAAU,gBAAgB,KAAK,WAAW;AAC1C,WAAU,cAAc,KAAK,mBAAmB;AAChD,WAAU,WAAW,KAAK,gBAAgB;AAC1C,WAAU,OAAO,KAAK,mBAAmB;AACzC,WAAU,eAAe,KAAK,2BAA2B;AACzD,WAAU,aAAa,KAAK,uBAAuB;AACnD,WAAU,kBAAkB,KAAK,aAAa;AAC9C,WAAU,4BAA4B,KAAK;AAC3C,QAAO;;;;;AAMT,eAAsB,cACpB,IACA,gBACA,OACiC;CAEjC,MAAM,iBAAiB,KAAK,KAAK;AAGjC,KAAI,MAAO,OAAM;CAEjB,MAAM,EAAE,eAAe,gBAAgB,oBAAoB;CAI3D,MAAM,UAAU,IAAI,4BAA4B,IAAI;CAGpD,MAAM,UAAU,IAAI,QAAmD;CAGvE,IAAI,kBAA2B;CAC/B,IAAI,qBAAqB;CAGzB,MAAM,4BAAY,IAAI,KAAiB;;CAGvC,MAAM,gBAAgB,QAA4B;AAChD,MAAI,iBAAiB,IAAI,IAAI,UAAU,IAAI,IAAI,CAAE;AAEjD,MAAI,eAAe,IAAI,IAAI,EAAE;AAC3B,OAAI,MAAO,OAAM;AACjB;;AAGF,YAAU,IAAI,IAAI;AAElB,UAAQ,KACN,QAAQ,IAAI,YAAY;GACtB,MAAM,eAAe,GAAG,wBAAwB,KAAK,KAAK;GAC1D,MAAM,SAAS,GAAG,8BAA8B,IAAI;GAGpD,MAAM,QAAQ;AACd,OAAI,gBAAiB,mBAAkB;GAEvC,MAAM,CAAC,UAAU,MAAM,MAAM,QAAQ,IAAI,CAAC,cAAc,OAAO,CAAC;AAIhE,OAAI,OAAO;AACT;AACA,sBAAkB;;AAGpB,OAAI,aAAa,OAAW,QAAO;AACnC,OAAI,OAAO,OAAW,OAAM,IAAI,MAAM,uBAAuB;AAE7D,UAAO;IAAE,GAAG;IAAU;IAAI;IAC1B,CACH;;AAIH,eAAc,SAAS,QAAQ,aAAa,IAAI,CAAC;CAEjD,MAAM,SAAiC,EAAE;CACzC,IAAI;AACJ,SAAQ,cAAc,QAAQ,OAAO,MAAM,QAAW;EAEpD,IAAI,eAAe,MAAM;AACzB,MAAI,iBAAiB,OAEnB;AAEF,MAAI,oBAAoB,QAAW;GAEjC,MAAM,qBAAqB,gBAAgB,aAAa;AAExD,OAAI,MAAO,OAAM,gBAAgB,aAAa,OAAO,SAAS,mBAAmB;AACjF,kBAAe;IAAE,GAAG;IAAc,QAAQ;IAAoB;;AAIhE,eAAa,aAAa,MAAM;AAChC,OAAK,MAAM,SAAS,aAAa,QAAQ;AACvC,gBAAa,MAAM,MAAM;AACzB,gBAAa,MAAM,MAAM;;AAI3B,MAAI,OAAO;AACT,SAAM;AACN,SAAM,mBAAmB,aAAa,OAAO;AAC7C,SAAM,sBAAsB,aAAa,GAAG;AAC5C,SAAM,8BAA8B,aAAa,MAAM,UAAU;AACjE,QAAK,MAAM,MAAM,aAAa,GAAI,OAAM,0BAA0B,GAAG,MAAM;;AAI7E,SAAO,KAAK,aAAa;;AAI3B,KAAI,OAAO;AACT,QAAM,eAAe,KAAK,KAAK,GAAG;AAClC,QAAM,cAAc;;AAGtB,QAAO"}