chore: create fake events for blocks and connections instead of nodes (#321)

* chore: create fake event for block instead of node

* chore: create fake event for connection instead of node

Author: rachel-fenichel

src/actions/action_menu.ts

@@ -15,7 +15,7 @@ import {
   WidgetDiv,
 } from 'blockly';
 import * as Constants from '../constants';
-import type {BlockSvg, WorkspaceSvg} from 'blockly';
+import type {BlockSvg, RenderedConnection, WorkspaceSvg} from 'blockly';
 import {Navigation} from '../navigation';
 
 const KeyCodes = BlocklyUtils.KeyCodes;
@@ -140,34 +140,7 @@ export class ActionMenu {
         // Slightly hacky: get insert action from registry.  Hacky
         // because registry typings don't include {connection: ...} as
         // a possible kind of scope.
-        const insertAction = ContextMenuRegistry.registry.getItem('insert');
-        if (!insertAction) throw new Error("can't find insert action");
-
-        const pasteAction = ContextMenuRegistry.registry.getItem(
-          'blockPasteFromContextMenu',
-        );
-        if (!pasteAction) throw new Error("can't find paste action");
-        const possibleOptions = [insertAction, pasteAction /* etc.*/];
-
-        // Check preconditions and get menu texts.
-        const scope = {
-          connection,
-        } as unknown as ContextMenuRegistry.Scope;
-        for (const option of possibleOptions) {
-          const precondition = option.preconditionFn(scope);
-          if (precondition === 'hidden') continue;
-          const displayText =
-            typeof option.displayText === 'function'
-              ? option.displayText(scope)
-              : option.displayText;
-          menuOptions.push({
-            text: displayText,
-            enabled: precondition === 'enabled',
-            callback: option.callback,
-            scope,
-            weight: option.weight,
-          });
-        }
+        this.addConnectionItems(connection, menuOptions);
         break;
 
       default:
@@ -195,6 +168,50 @@ export class ActionMenu {
     return true;
   }
 
+  /**
+   * Add menu items for a context menu on a connection scope.
+   *
+   * @param connection The connection on which the menu is shown.
+   * @param menuOptions The list of options, which may be modified by this method.
+   */
+  private addConnectionItems(
+    connection: Connection,
+    menuOptions: (
+      | ContextMenuRegistry.ContextMenuOption
+      | ContextMenuRegistry.LegacyContextMenuOption
+    )[],
+  ) {
+    const insertAction = ContextMenuRegistry.registry.getItem('insert');
+    if (!insertAction) throw new Error("can't find insert action");
+
+    const pasteAction = ContextMenuRegistry.registry.getItem(
+      'blockPasteFromContextMenu',
+    );
+    if (!pasteAction) throw new Error("can't find paste action");
+    const possibleOptions = [insertAction, pasteAction /* etc.*/];
+
+    // Check preconditions and get menu texts.
+    const scope = {
+      connection,
+    } as unknown as ContextMenuRegistry.Scope;
+    for (const option of possibleOptions) {
+      const precondition = option.preconditionFn(scope);
+      if (precondition === 'hidden') continue;
+      const displayText =
+        typeof option.displayText === 'function'
+          ? option.displayText(scope)
+          : option.displayText;
+      menuOptions.push({
+        text: displayText,
+        enabled: precondition === 'enabled',
+        callback: option.callback,
+        scope,
+        weight: option.weight,
+      });
+    }
+    return menuOptions;
+  }
+
   /**
    * Create a fake PointerEvent for opening the action menu for the
    * given ASTNode.
@@ -205,31 +222,28 @@ export class ActionMenu {
   private fakeEventForNode(node: ASTNode): PointerEvent {
     switch (node.getType()) {
       case ASTNode.types.BLOCK:
-        return this.fakeEventForBlockNode(node);
+        return this.fakeEventForBlock(node.getLocation() as BlockSvg);
       case ASTNode.types.NEXT:
       case ASTNode.types.PREVIOUS:
       case ASTNode.types.INPUT:
-        return this.fakeEventForConnectionNode(node);
+        return this.fakeEventForConnectionNode(
+          node.getLocation() as RenderedConnection,
+        );
       default:
         throw new TypeError('unhandled node type');
     }
   }
 
   /**
-   * Create a fake PointerEvent for opening the action menu for the
-   * given ASTNode of type BLOCK.
+   * Create a fake PointerEvent for opening the action menu on the specified
+   * block.
    *
-   * @param node The node to open the action menu for.
+   * @param block The block to open the action menu for.
    * @returns A synthetic pointerdown PointerEvent.
    */
-  private fakeEventForBlockNode(node: ASTNode): PointerEvent {
-    if (node.getType() !== ASTNode.types.BLOCK) {
-      throw new TypeError('can only create PointerEvents for BLOCK nodes');
-    }
-
+  private fakeEventForBlock(block: BlockSvg) {
     // Get the location of the top-left corner of the block in
     // screen coordinates.
-    const block = node.getLocation() as BlockSvg;
     const blockCoords = BlocklyUtils.svgMath.wsToScreenCoordinates(
       block.workspace,
       block.getRelativeToSurfaceXY(),
@@ -257,31 +271,23 @@ export class ActionMenu {
 
   /**
    * Create a fake PointerEvent for opening the action menu for the
-   * given ASTNode of type NEXT, PREVIOUS or INPUT.
+   * given connection.
    *
    * For now this just puts the action menu in the same place as the
    * context menu for the source block.
    *
-   * @param node The node to open the action menu for.
+   * @param connection The node to open the action menu for.
    * @returns A synthetic pointerdown PointerEvent.
    */
-  private fakeEventForConnectionNode(node: ASTNode): PointerEvent {
-    if (
-      node.getType() !== ASTNode.types.NEXT &&
-      node.getType() !== ASTNode.types.PREVIOUS &&
-      node.getType() !== ASTNode.types.INPUT
-    ) {
-      throw new TypeError('can only create PointerEvents for connection nodes');
-    }
-
-    const connection = node.getLocation() as Connection;
-    const block = connection.getSourceBlock();
+  private fakeEventForConnectionNode(
+    connection: RenderedConnection,
+  ): PointerEvent {
+    const block = connection.getSourceBlock() as BlockSvg;
     const workspace = block.workspace as WorkspaceSvg;
 
     if (typeof connection.x !== 'number') {
       // No coordinates for connection?  Fall back to the parent block.
-      const blockNode = new ASTNode(ASTNode.types.BLOCK, block);
-      return this.fakeEventForBlockNode(blockNode);
+      return this.fakeEventForBlock(block);
     }
     const connectionWSCoords = new BlocklyUtils.Coordinate(
       connection.x,