remove(devtools): Prototype editing code (#23741)

This code was developed as a prototype but was never formalized and is
not on the near-term product roadmap. Removing the code for now to
reduce maintenance burden.

Note: backwards compatibility with the browser extension is not a
concern here for 2 reasons:
1. The API exposes no way to enable editing, so no clients could be
using the functionality
2. Even if somehow the browser extension was sending edit messages to
the client, they would simply be ignored.

Author: Josmithr

packages/tools/devtools/devtools-core/.eslintrc.cjs

@@ -26,7 +26,7 @@ module.exports = {
 				"import/no-nodejs-modules": "off",
 				"unicorn/prefer-module": "off",
 
-				// Superceded by chai-expect rule
+				// Superseded by chai-expect rule
 				"@typescript-eslint/no-unused-expressions": "off",
 			},
 		},

packages/tools/devtools/devtools-core/src/ContainerDevtools.ts

@@ -19,8 +19,6 @@ import {
 	DataVisualizerGraph,
 	type FluidObjectNode,
 	type RootHandleNode,
-	type SharedObjectEdit,
-	defaultEditors,
 	defaultVisualizers,
 } from "./data-visualization/index.js";
 import {
@@ -30,7 +28,6 @@ import {
 	ContainerDevtoolsFeatures,
 	ContainerStateChange,
 	ContainerStateHistory,
-	DataEdit,
 	DataVisualization,
 	DisconnectContainer,
 	GetAudienceSummary,
@@ -333,15 +330,6 @@ export class ContainerDevtools implements IContainerDevtools, HasContainerKey {
 			}
 			return false;
 		},
-
-		[DataEdit.MessageType]: async (untypedMessage) => {
-			const message = untypedMessage as DataEdit.Message;
-			if (message.data.containerKey === this.containerKey) {
-				await this.editData(message.data.edit);
-				return true;
-			}
-			return false;
-		},
 	};
 
 	/**
@@ -468,7 +456,7 @@ export class ContainerDevtools implements IContainerDevtools, HasContainerKey {
 		this.dataVisualizer =
 			props.containerData === undefined
 				? undefined
-				: new DataVisualizerGraph(props.containerData, defaultVisualizers, defaultEditors);
+				: new DataVisualizerGraph(props.containerData, defaultVisualizers);
 
 		this.dataVisualizer?.on("update", this.dataUpdateHandler);
 
@@ -545,9 +533,6 @@ export class ContainerDevtools implements IContainerDevtools, HasContainerKey {
 		return {
 			// If no container data was provided to the devtools, we cannot support data visualization.
 			containerDataVisualization: this.containerData !== undefined,
-
-			// TODO: When ready to enable feature set it to this.containerData !== undefined
-			containerDataEditing: false,
 		};
 	}
 
@@ -577,11 +562,4 @@ export class ContainerDevtools implements IContainerDevtools, HasContainerKey {
 	): Promise<FluidObjectNode | undefined> {
 		return this.dataVisualizer?.render(fluidObjectId) ?? undefined;
 	}
-
-	/**
-	 * Applies an {@link Edit} to a {@link SharedObject}
-	 */
-	private async editData(edit: SharedObjectEdit): Promise<void> {
-		return this.dataVisualizer?.applyEdit(edit);
-	}
 }

packages/tools/devtools/devtools-core/src/Features.ts

@@ -51,9 +51,4 @@ export interface ContainerDevtoolsFeatureFlags {
 	 * Indicates that the Container Devtools supports visualizing the data associated with the Container.
 	 */
 	containerDataVisualization?: boolean;
-
-	/**
-	 * Indicates that the Container Devtools supports editing the data associated with the Container.
-	 */
-	containerDataEditing?: boolean;
 }

packages/tools/devtools/devtools-core/src/data-visualization/DataEditing.ts

@@ -19,7 +19,6 @@ import type { ISharedObject } from "@fluidframework/shared-object-base/internal"
 
 import type { FluidObjectId } from "../CommonInterfaces.js";
 
-import type { Edit, EditSharedObject, SharedObjectEdit } from "./DataEditing.js";
 import { visualizeUnknownSharedObject } from "./DefaultVisualizers.js";
 import {
 	type FluidObjectNode,
@@ -100,23 +99,6 @@ export interface SharedObjectVisualizers {
 	[k: SharedObjectType]: VisualizeSharedObject;
 }
 
-/**
- * Specifies editors for different {@link @fluidframework/shared-object-base#ISharedObject} types.
- *
- * @remarks
- *
- * - `key`: The type of Shared object ({@link @fluidframework/datastore-definitions#IChannelFactory.Type}).
- *
- * - `value`: A editor that takes a {@link @fluidframework/shared-object-base#ISharedObject} of the
- * specified type and preforms the corresponding edit for it.
- */
-export interface SharedObjectEditors {
-	/**
-	 * Individual Fluid object editors, keyed by {@link SharedObjectType}.
-	 */
-	[k: SharedObjectType]: EditSharedObject;
-}
-
 /**
  * Data visualization update events.
  */
@@ -178,11 +160,6 @@ export class DataVisualizerGraph
 		 * Policy object for visualizing different kinds of shared objects.
 		 */
 		private readonly visualizers: SharedObjectVisualizers,
-
-		/**
-		 * Policy object for editing different kinds of shared objects.
-		 */
-		private readonly editors: SharedObjectEditors,
 	) {
 		super();
 
@@ -243,15 +220,6 @@ export class DataVisualizerGraph
 		return this.visualizerNodes.get(fluidObjectId)?.render() ?? undefined;
 	}
 
-	/**
-	 * Applies an edit to a Fluid object.
-	 * @param edit - is a Edit object that describes an edit to a Fluid object.
-	 * @returns A promise that resolves when the editing of a {@link @fluidframework/shared-object-base#ISharedObject} is complete
-	 */
-	public async applyEdit(edit: SharedObjectEdit): Promise<void> {
-		return this.visualizerNodes.get(edit.fluidObjectId)?.applyEdit(edit);
-	}
-
 	/**
 	 * Adds a visualizer node to the collection for the specified
 	 * {@link @fluidframework/shared-object-base#ISharedObject} if one does not already exist.
@@ -262,13 +230,9 @@ export class DataVisualizerGraph
 			const visualizationFunction =
 				this.visualizers[sharedObject.attributes.type] ?? visualizeUnknownSharedObject;
 
-			// Create visualizer node for the shared object
-			const editorFunction = this.editors[sharedObject.attributes.type];
-
 			const visualizerNode = new VisualizerNode(
 				sharedObject,
 				visualizationFunction,
-				editorFunction,
 				async (handle) => this.registerVisualizerForHandle(handle),
 			);
 
@@ -378,12 +342,6 @@ export class VisualizerNode
 		 */
 		private readonly visualizeSharedObject: VisualizeSharedObject,
 
-		/**
-		 * Callback for editing {@link VisualizerNode.sharedObject}.
-		 * Encapsulates the policies for editing different kinds of DDSs.
-		 */
-		private readonly editSharedObject: EditSharedObject,
-
 		/**
 		 * Registers some child handle to a Fluid object for future rendering.
 		 *
@@ -442,15 +400,6 @@ export class VisualizerNode
 		);
 	}
 
-	/**
-	 * Edits a {@link @fluidframework/shared-object-base#ISharedObject}
-	 * @param edit - Describes an edit to a Fluid object.
-	 * @returns A promise that resolves when the editing of a {@link @fluidframework/shared-object-base#ISharedObject} is complete
-	 */
-	public async applyEdit(edit: Edit): Promise<void> {
-		return this.editSharedObject(this.sharedObject, edit);
-	}
-
 	/**
 	 * {@inheritDoc VisualizeChildData}
 	 */

packages/tools/devtools/devtools-core/src/data-visualization/DataVisualization.ts

@@ -309,7 +309,6 @@ export const visualizeUnknownSharedObject: VisualizeSharedObject = async (
 export const defaultVisualizers: Record<string, VisualizeSharedObject> = {
 	[SharedCell.getFactory().type]: visualizeSharedCell,
 	[SharedCounter.getFactory().type]: visualizeSharedCounter,
-	// eslint-disable-next-line import/no-deprecated
 	[SharedDirectory.getFactory().type]: visualizeSharedDirectory,
 	[SharedMap.getFactory().type]: visualizeSharedMap,
 	[SharedMatrix.getFactory().type]: visualizeSharedMatrix,

packages/tools/devtools/devtools-core/src/data-visualization/DefaultEditors.ts

@@ -15,8 +15,6 @@ export {
 	visualizeChildData,
 	VisualizerNode,
 } from "./DataVisualization.js";
-export type { Edit, EditData, EditSharedObject, SharedObjectEdit } from "./DataEditing.js";
-export { defaultEditors } from "./DefaultEditors.js";
 export {
 	defaultVisualizers,
 	visualizeSharedCell,

packages/tools/devtools/devtools-core/src/data-visualization/DefaultVisualizers.ts

@@ -34,9 +34,6 @@ export { ContainerStateChangeKind } from "./Container.js";
 export type { ContainerDevtoolsProps } from "./ContainerDevtools.js";
 export type { ContainerStateMetadata } from "./ContainerMetadata.js";
 export type {
-	Edit,
-	EditData,
-	EditSharedObject,
 	FluidHandleNode,
 	FluidObjectNode,
 	FluidObjectNodeBase,
@@ -45,7 +42,6 @@ export type {
 	FluidUnknownObjectNode,
 	Primitive,
 	RootHandleNode,
-	SharedObjectEdit,
 	TreeNodeBase,
 	ValueNodeBase,
 	VisualChildNode,
@@ -83,7 +79,6 @@ export {
 	ContainerList,
 	ContainerStateChange,
 	ContainerStateHistory,
-	DataEdit,
 	DataVisualization,
 	DevtoolsDisposed,
 	DevtoolsFeatures,

packages/tools/devtools/devtools-core/src/data-visualization/index.ts

@@ -106,18 +106,27 @@ export function handleIncomingMessage(
 ): void {
 	// TODO: remove loggingOptions once things settle.
 
-	if (message === undefined || !isDevtoolsMessage(message)) {
+	const loggingPreamble =
+		loggingOptions?.context === undefined ? "" : `${loggingOptions.context}: `;
+
+	if (message === undefined) {
+		console.error(`${loggingPreamble} No message provided to handle.`);
+		return;
+	}
+
+	if (!isDevtoolsMessage(message)) {
+		console.debug(`${loggingPreamble} Ignoring non-devtools message.`);
 		return;
 	}
 
 	if (handlers[message.type] === undefined) {
 		// No handler for this type provided. No-op.
+		console.debug(
+			`${loggingPreamble} Ignoring message of type: "${message.type}", for which no handler was provided.`,
+		);
 		return;
 	}
 
-	const loggingPreamble =
-		loggingOptions?.context === undefined ? "" : `${loggingOptions.context}: `;
-
 	handlers[message.type](message).then(
 		(wasMessageHandled) => {
 			// Only log if the message was actually handled by the recipient.