@fluidframework/container-runtime 2.0.0-internal.6.1.1 → 2.0.0-internal.6.3.0

package/src/dataStore.ts

@@ -3,10 +3,9 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryLoggerExt, TelemetryDataTag } from "@fluidframework/telemetry-utils";
-import { assert, unreachableCase } from "@fluidframework/common-utils";
+import { ITelemetryLoggerExt, TelemetryDataTag, UsageError } from "@fluidframework/telemetry-utils";
+import { assert, unreachableCase } from "@fluidframework/core-utils";
 import { AttachState } from "@fluidframework/container-definitions";
-import { UsageError } from "@fluidframework/container-utils";
 import { FluidObject, IFluidHandle, IRequest, IResponse } from "@fluidframework/core-interfaces";
 import {
 	AliasResult,

package/src/dataStoreContext.ts

@@ -17,8 +17,8 @@ import {
 	AttachState,
 	ILoaderOptions,
 } from "@fluidframework/container-definitions";
-import { assert, Deferred, TypedEventEmitter } from "@fluidframework/common-utils";
-import { LazyPromise } from "@fluidframework/core-utils";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { assert, Deferred, LazyPromise } from "@fluidframework/core-utils";
 import { IDocumentStorageService } from "@fluidframework/driver-definitions";
 import { BlobTreeEntry, readAndParse } from "@fluidframework/driver-utils";
 import {
@@ -57,6 +57,9 @@ import {
 import { addBlobToSummary, convertSummaryTreeToITree } from "@fluidframework/runtime-utils";
 import {
 	createChildMonitoringContext,
+	DataCorruptionError,
+	DataProcessingError,
+	extractSafePropertiesFromMessage,
 	generateStack,
 	ITelemetryLoggerExt,
 	LoggingError,
@@ -64,12 +67,6 @@ import {
 	tagCodeArtifacts,
 	ThresholdCounter,
 } from "@fluidframework/telemetry-utils";
-import {
-	DataCorruptionError,
-	DataProcessingError,
-	extractSafePropertiesFromMessage,
-} from "@fluidframework/container-utils";
-
 import {
 	dataStoreAttributesBlobName,
 	hasIsolatedChannels,

package/src/dataStoreContexts.ts

@@ -3,10 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryBaseLogger } from "@fluidframework/common-definitions";
-import { assert, Deferred } from "@fluidframework/common-utils";
-import { Lazy } from "@fluidframework/core-utils";
-import { IDisposable } from "@fluidframework/core-interfaces";
+import { assert, Deferred, Lazy } from "@fluidframework/core-utils";
+import { IDisposable, ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
 import { createChildLogger, ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import { FluidDataStoreContext, LocalFluidDataStoreContext } from "./dataStoreContext";
 

package/src/dataStoreRegistry.ts

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { UsageError } from "@fluidframework/container-utils";
+import { UsageError } from "@fluidframework/telemetry-utils";
 import {
 	FluidDataStoreRegistryEntry,
 	IFluidDataStoreRegistry,

package/src/dataStores.ts

@@ -3,10 +3,6 @@
  * Licensed under the MIT License.
  */
 
-import {
-	DataCorruptionError,
-	extractSafePropertiesFromMessage,
-} from "@fluidframework/container-utils";
 import {
 	ITelemetryBaseLogger,
 	IDisposable,
@@ -42,15 +38,16 @@ import {
 	unpackChildNodesUsedRoutes,
 } from "@fluidframework/runtime-utils";
 import {
+	createChildMonitoringContext,
+	DataCorruptionError,
+	extractSafePropertiesFromMessage,
 	LoggingError,
 	MonitoringContext,
-	createChildMonitoringContext,
 	tagCodeArtifacts,
 } from "@fluidframework/telemetry-utils";
 import { AttachState } from "@fluidframework/container-definitions";
 import { buildSnapshotTree } from "@fluidframework/driver-utils";
-import { assert } from "@fluidframework/common-utils";
-import { Lazy } from "@fluidframework/core-utils";
+import { assert, Lazy } from "@fluidframework/core-utils";
 import { v4 as uuid } from "uuid";
 import { DataStoreContexts } from "./dataStoreContexts";
 import {

package/src/deltaManagerProxyBase.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { EventForwarder } from "@fluidframework/common-utils";
+import { EventForwarder } from "@fluid-internal/client-utils";
 import {
 	IDeltaManager,
 	IDeltaManagerEvents,

package/src/deltaScheduler.ts

@@ -4,7 +4,7 @@
  */
 
 import { ITelemetryLoggerExt, formatTick } from "@fluidframework/telemetry-utils";
-import { performance } from "@fluidframework/common-utils";
+import { performance } from "@fluid-internal/client-utils";
 import { IDeltaManager } from "@fluidframework/container-definitions";
 import { IDocumentMessage, ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
 

package/src/error.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ContainerErrorTypes } from "@fluidframework/container-definitions";
+import { IFluidErrorBase, LoggingError } from "@fluidframework/telemetry-utils";
+
+/**
+ * Error indicating that a client's session has reached its time limit and is closed.
+ */
+export class ClientSessionExpiredError extends LoggingError implements IFluidErrorBase {
+	readonly errorType = ContainerErrorTypes.clientSessionExpiredError;
+
+	constructor(message: string, readonly expiryMs: number) {
+		super(message, { timeoutMs: expiryMs });
+	}
+}

package/src/gc/garbageCollection.ts

@@ -3,10 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { Timer } from "@fluidframework/common-utils";
-import { LazyPromise } from "@fluidframework/core-utils";
-import { ClientSessionExpiredError, DataProcessingError } from "@fluidframework/container-utils";
-import { IRequestHeader } from "@fluidframework/core-interfaces";
+import { LazyPromise, Timer } from "@fluidframework/core-utils";
+import { IRequest, IRequestHeader } from "@fluidframework/core-interfaces";
 import {
 	gcTreeKey,
 	IGarbageCollectionData,
@@ -14,17 +12,23 @@ import {
 	ISummarizeResult,
 	ITelemetryContext,
 } from "@fluidframework/runtime-definitions";
-import { ReadAndParseBlob } from "@fluidframework/runtime-utils";
+import { createResponseError, responseToException } from "@fluidframework/runtime-utils";
 import {
 	createChildLogger,
 	createChildMonitoringContext,
+	DataProcessingError,
 	ITelemetryLoggerExt,
 	MonitoringContext,
 	PerformanceEvent,
 } from "@fluidframework/telemetry-utils";
 
-import { RuntimeHeaders } from "../containerRuntime";
-import { RefreshSummaryResult } from "../summary";
+import {
+	AllowInactiveRequestHeaderKey,
+	InactiveResponseHeaderKey,
+	RuntimeHeaders,
+} from "../containerRuntime";
+import { ClientSessionExpiredError } from "../error";
+import { IRefreshSummaryResult } from "../summary";
 import { generateGCConfigs } from "./gcConfigs";
 import {
 	GCNodeType,
@@ -838,45 +842,15 @@ export class GarbageCollector implements IGarbageCollector {
 	}
 
 	/**
-	 * Called to refresh the latest summary state. This happens when either a pending summary is acked or a snapshot
-	 * is downloaded and should be used to update the state.
+	 * Called to refresh the latest summary state. This happens when either a pending summary is acked.
 	 */
-	public async refreshLatestSummary(
-		proposalHandle: string | undefined,
-		result: RefreshSummaryResult,
-		readAndParseBlob: ReadAndParseBlob,
-	): Promise<void> {
-		const latestSnapshotData = await this.summaryStateTracker.refreshLatestSummary(
-			proposalHandle,
-			result,
-			readAndParseBlob,
-		);
-
-		// If the latest summary was updated but it was not tracked by this client, our state needs to be updated from
-		// this snapshot data.
-		if (this.shouldRunGC && result.latestSummaryUpdated && !result.wasSummaryTracked) {
-			// The current reference timestamp should be available if we are refreshing state from a snapshot. There has
-			// to be at least one op (summary op / ack, if nothing else) if a snapshot was taken.
-			const currentReferenceTimestampMs = this.runtime.getCurrentReferenceTimestampMs();
-			if (currentReferenceTimestampMs === undefined) {
-				throw DataProcessingError.create(
-					"No reference timestamp when updating GC state from snapshot",
-					"refreshLatestSummary",
-					undefined,
-					{
-						proposalHandle,
-						summaryRefSeq: result.summaryRefSeq,
-						gcConfigs: JSON.stringify(this.configs),
-					},
-				);
-			}
-			this.updateStateFromSnapshotData(latestSnapshotData, currentReferenceTimestampMs);
-		}
+	public async refreshLatestSummary(result: IRefreshSummaryResult): Promise<void> {
+		return this.summaryStateTracker.refreshLatestSummary(result);
 	}
 
 	/**
 	 * Called when a node with the given id is updated. If the node is inactive, log an error.
-	 * @param nodePath - The id of the node that changed.
+	 * @param nodePath - The path of the node that changed.
 	 * @param reason - Whether the node was loaded or changed.
 	 * @param timestampMs - The timestamp when the node changed.
 	 * @param packagePath - The package path of the node. This may not be available if the node hasn't been loaded yet.
@@ -893,6 +867,7 @@ export class GarbageCollector implements IGarbageCollector {
 			return;
 		}
 
+		// This will log if appropriate
 		this.telemetryTracker.nodeUsed({
 			id: nodePath,
 			usageType: reason,
@@ -904,6 +879,29 @@ export class GarbageCollector implements IGarbageCollector {
 			lastSummaryTime: this.getLastSummaryTimestampMs(),
 			viaHandle: requestHeaders?.[RuntimeHeaders.viaHandle],
 		});
+
+		// Unless this is a Loaded event, we're done after telemetry tracking
+		if (reason !== "Loaded") {
+			return;
+		}
+
+		// We may throw when loading an Inactive object, depending on these preconditions
+		const shouldThrowOnInactiveLoad =
+			!this.isSummarizerClient &&
+			this.configs.throwOnInactiveLoad === true &&
+			requestHeaders?.[AllowInactiveRequestHeaderKey] !== true;
+		const state = this.unreferencedNodesState.get(nodePath)?.state;
+
+		if (shouldThrowOnInactiveLoad && state === "Inactive") {
+			const request: IRequest = { url: nodePath };
+			const error = responseToException(
+				createResponseError(404, "Object is inactive", request, {
+					[InactiveResponseHeaderKey]: true,
+				}),
+				request,
+			);
+			throw error;
+		}
 	}
 
 	/**

package/src/gc/gcConfigs.ts

@@ -3,8 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { UsageError } from "@fluidframework/container-utils";
-import { MonitoringContext } from "@fluidframework/telemetry-utils";
+import { MonitoringContext, UsageError } from "@fluidframework/telemetry-utils";
 import { IContainerRuntimeMetadata } from "../summary";
 import {
 	currentGCVersion,
@@ -153,6 +152,8 @@ export function generateGCConfigs(
 		throw new UsageError("inactive timeout should not be greater than the sweep timeout");
 	}
 
+	const throwOnInactiveLoad: boolean | undefined = createParams.gcOptions.throwOnInactiveLoad;
+
 	// Whether we are running in test mode. In this mode, unreferenced nodes are immediately deleted.
 	const testMode =
 		mc.config.getBoolean(gcTestModeKey) ?? createParams.gcOptions.runGCInTestMode === true;
@@ -172,6 +173,7 @@ export function generateGCConfigs(
 		sessionExpiryTimeoutMs,
 		sweepTimeoutMs,
 		inactiveTimeoutMs,
+		throwOnInactiveLoad,
 		persistedGcFeatureMatrix,
 		gcVersionInBaseSnapshot,
 		gcVersionInEffect,

package/src/gc/gcDefinitions.ts

@@ -17,7 +17,7 @@ import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils";
 import {
 	IContainerRuntimeMetadata,
 	ICreateContainerMetadata,
-	RefreshSummaryResult,
+	IRefreshSummaryResult,
 } from "../summary";
 
 export type GCVersion = number;
@@ -228,11 +228,7 @@ export interface IGarbageCollector {
 	/** Returns the GC details generated from the base snapshot. */
 	getBaseGCDetails(): Promise<IGarbageCollectionDetailsBase>;
 	/** Called when the latest summary of the system has been refreshed. */
-	refreshLatestSummary(
-		proposalHandle: string | undefined,
-		result: RefreshSummaryResult,
-		readAndParseBlob: ReadAndParseBlob,
-	): Promise<void>;
+	refreshLatestSummary(result: IRefreshSummaryResult): Promise<void>;
 	/** Called when a node is updated. Used to detect and log when an inactive node is changed or loaded. */
 	nodeUpdated(
 		nodePath: string,
@@ -349,6 +345,8 @@ export interface IGarbageCollectorConfigs {
 	readonly sweepTimeoutMs: number | undefined;
 	/** The time after which an unreferenced node is inactive. */
 	readonly inactiveTimeoutMs: number;
+	/** It is easier for users to diagnose InactiveObject usage if we throw on load, which this option enables */
+	readonly throwOnInactiveLoad: boolean | undefined;
 	/** Tracks whether GC should run in test mode. In this mode, unreferenced objects are deleted immediately. */
 	readonly testMode: boolean;
 	/**

package/src/gc/gcHelpers.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { assert } from "@fluidframework/common-utils";
+import { assert } from "@fluidframework/core-utils";
 import { ISnapshotTree } from "@fluidframework/protocol-definitions";
 import {
 	gcBlobPrefix,

package/src/gc/gcSummaryStateTracker.ts

@@ -12,12 +12,11 @@ import {
 	ISummarizeResult,
 	ISummaryTreeWithStats,
 } from "@fluidframework/runtime-definitions";
-import { mergeStats, ReadAndParseBlob, SummaryTreeBuilder } from "@fluidframework/runtime-utils";
-import { IContainerRuntimeMetadata, metadataBlobName, RefreshSummaryResult } from "../summary";
-import { GCVersion, IGCStats } from "./gcDefinitions";
-import { getGCDataFromSnapshot, generateSortedGCState, getGCVersion } from "./gcHelpers";
+import { mergeStats, SummaryTreeBuilder } from "@fluidframework/runtime-utils";
+import { IRefreshSummaryResult } from "../summary";
+import { GCVersion, IGarbageCollectorConfigs, IGCStats } from "./gcDefinitions";
+import { generateSortedGCState } from "./gcHelpers";
 import { IGarbageCollectionSnapshotData, IGarbageCollectionState } from "./gcSummaryDefinitions";
-import { IGarbageCollectorConfigs } from ".";
 
 export const gcStateBlobKey = `${gcBlobPrefix}_root`;
 
@@ -264,72 +263,27 @@ export class GCSummaryStateTracker {
 	}
 
 	/**
-	 * Called to refresh the latest summary state. This happens when either a pending summary is acked or a snapshot
-	 * is downloaded and should be used to update the state.
+	 * Called to refresh the latest summary state. This happens when either a pending summary is acked.
 	 */
-	public async refreshLatestSummary(
-		proposalHandle: string | undefined,
-		result: RefreshSummaryResult,
-		readAndParseBlob: ReadAndParseBlob,
-	): Promise<IGarbageCollectionSnapshotData | undefined> {
-		// If the latest summary was updated and the summary was tracked, this client is the one that generated this
-		// summary. So, update wasGCRunInLatestSummary.
-		// Note that this has to be updated if GC did not run too. Otherwise, `gcStateNeedsReset` will always return
-		// true in scenarios where GC is disabled but enabled in the snapshot we loaded from.
-		if (result.latestSummaryUpdated && result.wasSummaryTracked) {
-			this.wasGCRunInLatestSummary = this.configs.shouldRunGC;
-		}
-
-		if (!result.latestSummaryUpdated || !this.configs.shouldRunGC) {
-			return undefined;
-		}
-
-		// If the summary was tracked by this client, it was the one that generated the summary in the first place.
-		// Update latest state from pending.
-		if (result.wasSummaryTracked) {
-			this.latestSummaryGCVersion = this.configs.gcVersionInEffect;
-			this.latestSummaryData = this.pendingSummaryData;
-			this.pendingSummaryData = undefined;
-			this.updatedDSCountSinceLastSummary = 0;
-			return undefined;
-		}
-
-		// If the summary was not tracked by this client, the state should be updated from the downloaded snapshot.
-		const snapshotTree = result.snapshotTree;
-		const metadataBlobId = snapshotTree.blobs[metadataBlobName];
-		const metadata = metadataBlobId
-			? await readAndParseBlob<IContainerRuntimeMetadata>(metadataBlobId)
-			: undefined;
-		this.latestSummaryGCVersion = getGCVersion(metadata);
-
-		const gcSnapshotTree = snapshotTree.trees[gcTreeKey];
-		// If GC ran in the container that generated this snapshot, it will have a GC tree.
-		this.wasGCRunInLatestSummary = gcSnapshotTree !== undefined;
-
-		if (gcSnapshotTree === undefined) {
-			return undefined;
+	public async refreshLatestSummary(result: IRefreshSummaryResult): Promise<void> {
+		if (!result.isSummaryTracked) {
+			return;
 		}
 
-		let snapshotData = await getGCDataFromSnapshot(gcSnapshotTree, readAndParseBlob);
+		// If the summary is tracked, this client is the one that generated it. So, update wasGCRunInLatestSummary.
+		// Note that this has to be updated if GC did not run too. Otherwise, `gcStateNeedsReset` will always return
+		// true in scenarios where GC is currently disabled but enabled in the snapshot we loaded from.
+		this.wasGCRunInLatestSummary = this.configs.shouldRunGC;
 
-		// If the GC version in the snapshot does not match the GC version currently in effect, the GC data
-		// in the snapshot cannot be interpreted correctly. Set everything to undefined except for deletedNodes
-		// because irrespective of GC versions, these nodes have been deleted and cannot be brought back. The
-		// deletedNodes info is needed to identify when these nodes are used.
-		if (getGCVersion(metadata) !== this.configs.gcVersionInEffect) {
-			snapshotData = {
-				gcState: undefined,
-				tombstones: undefined,
-				deletedNodes: snapshotData.deletedNodes,
-			};
+		if (!this.configs.shouldRunGC) {
+			return;
 		}
 
-		this.latestSummaryData = {
-			serializedGCState: JSON.stringify(snapshotData.gcState),
-			serializedTombstones: JSON.stringify(snapshotData.tombstones),
-			serializedDeletedNodes: JSON.stringify(snapshotData.deletedNodes),
-		};
-		return snapshotData;
+		this.latestSummaryGCVersion = this.configs.gcVersionInEffect;
+		this.latestSummaryData = this.pendingSummaryData;
+		this.pendingSummaryData = undefined;
+		this.updatedDSCountSinceLastSummary = 0;
+		return;
 	}
 
 	/**

package/src/gc/gcTelemetry.ts

@@ -23,6 +23,7 @@ import {
 	runSweepKey,
 } from "./gcDefinitions";
 import { UnreferencedStateTracker } from "./gcUnreferencedStateTracker";
+// eslint-disable-next-line import/no-deprecated
 import { tagAsCodeArtifact } from "./gcHelpers";
 
 type NodeUsageType = "Changed" | "Loaded" | "Revived";
@@ -183,6 +184,7 @@ export class GCTelemetryTracker {
 				{
 					eventName: `GC_Tombstone_${nodeType}_Revived`,
 					category: "generic",
+					// eslint-disable-next-line import/no-deprecated
 					url: tagAsCodeArtifact(id),
 					gcTombstoneEnforcementAllowed: this.gcTombstoneEnforcementAllowed,
 				},

package/src/gc/gcUnreferencedStateTracker.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { assert, Timer } from "@fluidframework/common-utils";
+import { assert, Timer } from "@fluidframework/core-utils";
 import { UnreferencedState } from "./gcDefinitions";
 
 /** A wrapper around common-utils Timer that requires the timeout when calling start/restart */

package/src/gc/index.ts

@@ -38,7 +38,6 @@ export {
 export {
 	cloneGCData,
 	concatGarbageCollectionStates,
-	getGCDataFromSnapshot,
 	shouldAllowGcTombstoneEnforcement,
 	shouldAllowGcSweep,
 	trimLeadingAndTrailingSlashes,

package/src/id-compressor/appendOnlySortedMap.ts

@@ -3,10 +3,9 @@
  * Licensed under the MIT License.
  */
 
+/* eslint-disable tsdoc/syntax */
 /* eslint-disable no-bitwise */
-
-import { assert } from "@fluidframework/common-utils";
-import { fail } from "./utils";
+import { assert } from "@fluidframework/core-utils";
 
 /**
  * A map in which entries are always added in key-sorted order.
@@ -133,7 +132,7 @@ export class AppendOnlySortedMap<K, V> {
 	}
 
 	/**
-	 * Adds a new key/value pair to the map. `key` must be \> to all keys in the map.
+	 * Adds a new key/value pair to the map. `key` must be > to all keys in the map.
 	 * @param key - the key to add.
 	 * @param value - the value to add.
 	 */
@@ -141,7 +140,27 @@ export class AppendOnlySortedMap<K, V> {
 		const { elements } = this;
 		const { length } = elements;
 		if (length !== 0 && this.comparator(key, this.maxKey() as K) <= 0) {
-			fail("Inserted key must be > all others in the map.");
+			throw new Error("Inserted key must be > all others in the map.");
+		}
+		elements.push(key);
+		elements.push(value);
+	}
+
+	/**
+	 * Replaces the last key/value pair with the given one. If the map is empty, it simply appends.
+	 * `key` must be > to all keys in the map prior to the one replaced.
+	 * @param key - the key to add.
+	 * @param value - the value to add.
+	 */
+	public replaceLast(key: K, value: V): void {
+		const { elements, comparator } = this;
+		const { length } = elements;
+		if (length !== 0) {
+			elements.pop();
+			elements.pop();
+			if (comparator(key, this.maxKey() as K) <= 0) {
+				throw new Error("Inserted key must be > all others in the map.");
+			}
 		}
 		elements.push(key);
 		elements.push(value);
@@ -217,7 +236,7 @@ export class AppendOnlySortedMap<K, V> {
 			if (prev !== undefined) {
 				assert(
 					this.comparator(kv[0], prev[0]) > 0,
-					0x47f /* Keys in map must be sorted. */,
+					0x752 /* Keys in map must be sorted. */,
 				);
 			}
 			prev = kv;
@@ -338,90 +357,10 @@ export class AppendOnlySortedMap<K, V> {
 			} else if (c === 0) {
 				return keyIndex;
 			} else {
-				fail("Invalid comparator.");
+				throw new Error("Invalid comparator.");
 			}
 			mid = (low + high) >> 1;
 		}
 		return (mid * 2) ^ AppendOnlySortedMap.failureXor;
 	}
 }
-
-/**
- * A map in which entries are always added in both key-sorted and value-sorted order.
- * Supports appending and searching.
- */
-export class AppendOnlyDoublySortedMap<K, V, S> extends AppendOnlySortedMap<K, V> {
-	public constructor(
-		keyComparator: (a: K, b: K) => number,
-		private readonly extractSearchValue: (value: V) => S,
-		private readonly valueComparator: (search: S, value: S) => number,
-	) {
-		super(keyComparator);
-	}
-
-	public override append(key: K, value: V): void {
-		if (
-			this.elements.length !== 0 &&
-			this.valueComparator(
-				this.extractSearchValue(value),
-				this.extractSearchValue(this.maxValue() as V),
-			) <= 0
-		) {
-			fail("Inserted value must be > all others in the map.");
-		}
-		super.append(key, value);
-	}
-
-	private readonly compareValues = (search: S, _: K, value: V): number => {
-		return this.valueComparator(search, this.extractSearchValue(value));
-	};
-
-	// /**
-	//  * @param value - the value to lookup.
-	//  * @returns the key associated with `value` if such an entry exists, and undefined otherwise.
-	//  */
-	// public getByValue(value: S): K | undefined {
-	//     const index = AppendOnlySortedMap.keyIndexOf(this.elements, value, this.compareValues);
-	//     return this.elements[index]?.[0];
-	// }
-
-	/**
-	 * @param searchValue - the search value to lookup.
-	 * @returns the entry who's value, when run through the extractor provided to the constructor, matches
-	 * `searchValue`. If no such entry exists, this method returns the next lower entry as determined by the value
-	 * comparator provided to the constructor. If no such entry exists, this method returns undefined.
-	 */
-	public getPairOrNextLowerByValue(searchValue: S): readonly [K, V] | undefined {
-		return this.getPairOrNextLowerBy(searchValue, this.compareValues);
-	}
-
-	/**
-	 * @param searchValue - the search value to lookup.
-	 * @returns the entry who's value, when run through the extractor provided to the constructor, matches `searchValue`. If no such entry
-	 * exists, this method returns the next higher entry as determined by the value comparator provided to the constructor. If no such entry
-	 * exists, this method returns undefined.
-	 */
-	public getPairOrNextHigherByValue(searchValue: S): readonly [K, V] | undefined {
-		return this.getPairOrNextHigherBy(searchValue, this.compareValues);
-	}
-
-	/**
-	 * Test-only expensive assertions to check the internal validity of the data structure.
-	 */
-	public override assertValid(): void {
-		super.assertValid();
-		let prev: readonly [unknown, V] | undefined;
-		for (const kv of this.entries()) {
-			if (prev !== undefined) {
-				assert(
-					this.valueComparator(
-						this.extractSearchValue(kv[1]),
-						this.extractSearchValue(prev[1]),
-					) > 0,
-					0x480 /* Values in map must be sorted. */,
-				);
-			}
-			prev = kv;
-		}
-	}
-}