refactor!: allows previously internal constants to be configurable (g…

…oogle#5897)

blocks/procedures.js

@@ -19,13 +19,13 @@ const Events = goog.require('Blockly.Events');
 const Procedures = goog.require('Blockly.Procedures');
 const Variables = goog.require('Blockly.Variables');
 const Xml = goog.require('Blockly.Xml');
-const internalConstants = goog.require('Blockly.internalConstants');
 const xmlUtils = goog.require('Blockly.utils.xml');
 const {Align} = goog.require('Blockly.Input');
 /* eslint-disable-next-line no-unused-vars */
 const {Block} = goog.requireType('Blockly.Block');
 /* eslint-disable-next-line no-unused-vars */
 const {BlockDefinition} = goog.requireType('Blockly.blocks');
+const {config} = goog.require('Blockly.config');
 /* eslint-disable-next-line no-unused-vars */
 const {FieldCheckbox} = goog.require('Blockly.FieldCheckbox');
 const {FieldLabel} = goog.require('Blockly.FieldLabel');
@@ -959,8 +959,8 @@ const PROCEDURE_CALL_COMMON = {
         const block = xmlUtils.createElement('block');
         block.setAttribute('type', this.defType_);
         const xy = this.getRelativeToSurfaceXY();
-        const x = xy.x + internalConstants.SNAP_RADIUS * (this.RTL ? -1 : 1);
-        const y = xy.y + internalConstants.SNAP_RADIUS * 2;
+        const x = xy.x + config.snapRadius * (this.RTL ? -1 : 1);
+        const y = xy.y + config.snapRadius * 2;
         block.setAttribute('x', x);
         block.setAttribute('y', y);
         const mutation = this.mutationToDom();

core/block_svg.js

@@ -34,6 +34,7 @@ const {Block} = goog.require('Blockly.Block');
 const {BlockMove} = goog.requireType('Blockly.Events.BlockMove');
 /* eslint-disable-next-line no-unused-vars */
 const {Comment} = goog.requireType('Blockly.Comment');
+const {config} = goog.require('Blockly.config');
 const {ConnectionType} = goog.require('Blockly.ConnectionType');
 /* eslint-disable-next-line no-unused-vars */
 const {Connection} = goog.requireType('Blockly.Connection');
@@ -1560,7 +1561,7 @@ BlockSvg.prototype.bumpNeighbours = function() {
       renderedConn.targetBlock().bumpNeighbours();
     }
 
-    const neighbours = renderedConn.neighbours(internalConstants.SNAP_RADIUS);
+    const neighbours = connection.neighbours(config.snapRadius);
     for (let j = 0, otherConnection; (otherConnection = neighbours[j]); j++) {
       const renderedOther =
           /** @type {!RenderedConnection} */ (otherConnection);
@@ -1595,13 +1596,13 @@ BlockSvg.prototype.scheduleSnapAndBump = function() {
     eventUtils.setGroup(group);
     block.snapToGrid();
     eventUtils.setGroup(false);
-  }, internalConstants.BUMP_DELAY / 2);
+  }, config.bumpDelay / 2);
 
   setTimeout(function() {
     eventUtils.setGroup(group);
     block.bumpNeighbours();
     eventUtils.setGroup(false);
-  }, internalConstants.BUMP_DELAY);
+  }, config.bumpDelay);
 };
 
 /**

core/blockly.js

@@ -71,6 +71,7 @@ const {Bubble} = goog.require('Blockly.Bubble');
 const {CollapsibleToolboxCategory} = goog.require('Blockly.CollapsibleToolboxCategory');
 const {Comment} = goog.require('Blockly.Comment');
 const {ComponentManager} = goog.require('Blockly.ComponentManager');
+const {config} = goog.require('Blockly.config');
 const {ConnectionChecker} = goog.require('Blockly.ConnectionChecker');
 const {ConnectionDB} = goog.require('Blockly.ConnectionDB');
 const {ConnectionType} = goog.require('Blockly.ConnectionType');
@@ -655,20 +656,8 @@ const bindEventWithChecks_ = function(
 exports.bindEventWithChecks_ = bindEventWithChecks_;
 
 // Aliases to allow external code to access these values for legacy reasons.
-exports.DRAG_RADIUS = internalConstants.DRAG_RADIUS;
-exports.FLYOUT_DRAG_RADIUS = internalConstants.FLYOUT_DRAG_RADIUS;
-exports.SNAP_RADIUS = internalConstants.SNAP_RADIUS;
-exports.CONNECTING_SNAP_RADIUS = internalConstants.CONNECTING_SNAP_RADIUS;
-exports.CURRENT_CONNECTION_PREFERENCE =
-    internalConstants.CURRENT_CONNECTION_PREFERENCE;
-exports.BUMP_DELAY = internalConstants.BUMP_DELAY;
 exports.COLLAPSE_CHARS = internalConstants.COLLAPSE_CHARS;
 exports.DRAG_STACK = internalConstants.DRAG_STACK;
-exports.SPRITE = internalConstants.SPRITE;
-exports.DRAG_NONE = internalConstants.DRAG_NONE;
-exports.DRAG_STICKY = internalConstants.DRAG_STICKY;
-exports.DRAG_BEGIN = internalConstants.DRAG_BEGIN;
-exports.DRAG_FREE = internalConstants.DRAG_FREE;
 exports.OPPOSITE_TYPE = internalConstants.OPPOSITE_TYPE;
 exports.RENAME_VARIABLE_ID = internalConstants.RENAME_VARIABLE_ID;
 exports.DELETE_VARIABLE_ID = internalConstants.DELETE_VARIABLE_ID;
@@ -828,6 +817,7 @@ exports.browserEvents = browserEvents;
 exports.bumpObjects = bumpObjects;
 exports.clipboard = clipboard;
 exports.common = common;
+exports.config = config;
 /** @deprecated Use Blockly.ConnectionType instead. */
 exports.connectionTypes = ConnectionType;
 exports.constants = constants;

core/config.js

@@ -0,0 +1,87 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview All the values that we expect developers to be able to change
+ * before injecting Blockly. Changing these values during run time is not
+ * generally recommended.
+ */
+'use strict';
+
+/**
+ * All the values that we expect developers to be able to change
+ * before injecting Blockly. Changing these values during run time is not
+ * generally recommended.
+ * @namespace Blockly.config
+ */
+goog.module('Blockly.config');
+
+
+/**
+ * All the values that we expect developers to be able to change
+ * before injecting Blockly.
+ * @typedef {{
+ *      dragRadius: number,
+ *      flyoutDragRadius: number,
+ *      snapRadius: number,
+ *      currentConnectionPreference: number,
+ *      bumpDelay: number,
+ *      connectingSnapRadius: number
+ *    }}
+ */
+let Config;  // eslint-disable-line no-unused-vars
+
+/**
+ * Default snap radius.
+ * @type {number}
+ */
+const DEFAULT_SNAP_RADIUS = 28;
+
+/**
+ * Object holding all the values on Blockly that we expect developers to be
+ * able to change.
+ * @type {Config}
+ */
+const config = {
+  /**
+   * Number of pixels the mouse must move before a drag starts.
+   * @alias Blockly.config.dragRadius
+   */
+  dragRadius: 5,
+  /**
+   * Number of pixels the mouse must move before a drag/scroll starts from the
+   * flyout.  Because the drag-intention is determined when this is reached, it
+   * is larger than dragRadius so that the drag-direction is clearer.
+   * @alias Blockly.config.flyoutDragRadius
+   */
+  flyoutDragRadius: 10,
+  /**
+   * Maximum misalignment between connections for them to snap together.
+   * @alias Blockly.config.snapRadius
+   */
+  snapRadius: DEFAULT_SNAP_RADIUS,
+  /**
+   * Maximum misalignment between connections for them to snap together.
+   * This should be the same as the snap radius.
+   * @alias Blockly.config.connectingSnapRadius
+   */
+  connectingSnapRadius: DEFAULT_SNAP_RADIUS,
+  /**
+   * How much to prefer staying connected to the current connection over moving
+   * to a new connection.  The current previewed connection is considered to be
+   * this much closer to the matching connection on the block than it actually
+   * is.
+   * @alias Blockly.config.currentConnectionPreference
+   */
+  currentConnectionPreference: 8,
+  /**
+   * Delay in ms between trigger and bumping unconnected block out of alignment.
+   * @alias Blockly.config.bumpDelay
+   */
+  bumpDelay: 250,
+};
+
+exports.config = config;

core/contextmenu.js

@@ -23,11 +23,11 @@ const clipboard = goog.require('Blockly.clipboard');
 const deprecation = goog.require('Blockly.utils.deprecation');
 const dom = goog.require('Blockly.utils.dom');
 const eventUtils = goog.require('Blockly.Events.utils');
-const internalConstants = goog.require('Blockly.internalConstants');
 const userAgent = goog.require('Blockly.utils.userAgent');
 const svgMath = goog.require('Blockly.utils.svgMath');
 /* eslint-disable-next-line no-unused-vars */
 const {Block} = goog.requireType('Blockly.Block');
+const {config} = goog.require('Blockly.config');
 const {Coordinate} = goog.require('Blockly.utils.Coordinate');
 const {MenuItem} = goog.require('Blockly.MenuItem');
 const {Menu} = goog.require('Blockly.Menu');
@@ -266,11 +266,11 @@ const callbackFactory = function(block, xml) {
       // Move the new block next to the old block.
       const xy = block.getRelativeToSurfaceXY();
       if (block.RTL) {
-        xy.x -= internalConstants.SNAP_RADIUS;
+        xy.x -= config.snapRadius;
       } else {
-        xy.x += internalConstants.SNAP_RADIUS;
+        xy.x += config.snapRadius;
       }
-      xy.y += internalConstants.SNAP_RADIUS * 2;
+      xy.y += config.snapRadius * 2;
       newBlock.moveBy(xy.x, xy.y);
     } finally {
       eventUtils.enable();

core/gesture.js

@@ -28,6 +28,7 @@ const registry = goog.require('Blockly.registry');
 /* eslint-disable-next-line no-unused-vars */
 const {BlockSvg} = goog.requireType('Blockly.BlockSvg');
 const {BubbleDragger} = goog.require('Blockly.BubbleDragger');
+const {config} = goog.require('Blockly.config');
 const {Coordinate} = goog.require('Blockly.utils.Coordinate');
 /* eslint-disable-next-line no-unused-vars */
 const {Field} = goog.requireType('Blockly.Field');
@@ -307,8 +308,8 @@ class Gesture {
       const currentDragDelta = Coordinate.magnitude(this.currentDragDeltaXY_);
 
       // The flyout has a different drag radius from the rest of Blockly.
-      const limitRadius = this.flyout_ ? internalConstants.FLYOUT_DRAG_RADIUS :
-                                         internalConstants.DRAG_RADIUS;
+      const limitRadius =
+          this.flyout_ ? config.flyoutDragRadius : config.dragRadius;
 
       this.hasExceededDragRadius_ = currentDragDelta > limitRadius;
       return this.hasExceededDragRadius_;

core/insertion_marker_manager.js

@@ -19,10 +19,10 @@ const blockAnimations = goog.require('Blockly.blockAnimations');
 const common = goog.require('Blockly.common');
 const constants = goog.require('Blockly.constants');
 const eventUtils = goog.require('Blockly.Events.utils');
-const internalConstants = goog.require('Blockly.internalConstants');
 /* eslint-disable-next-line no-unused-vars */
 const {BlockSvg} = goog.requireType('Blockly.BlockSvg');
 const {ComponentManager} = goog.require('Blockly.ComponentManager');
+const {config} = goog.require('Blockly.config');
 const {ConnectionType} = goog.require('Blockly.ConnectionType');
 /* eslint-disable-next-line no-unused-vars */
 const {Coordinate} = goog.requireType('Blockly.utils.Coordinate');
@@ -389,8 +389,7 @@ class InsertionMarkerManager {
         // Slightly prefer the existing preview over a new preview.
         return !(
             candidateClosest &&
-            radius >
-                curDistance - internalConstants.CURRENT_CONNECTION_PREFERENCE);
+            radius > curDistance - config.currentConnectionPreference);
       } else if (!this.localConnection_ && !this.closestConnection_) {
         // We weren't showing a preview before, but we should now.
         return true;
@@ -459,9 +458,9 @@ class InsertionMarkerManager {
     // of range. By increasing radiusConnection when a connection already
     // exists, we never "lose" the connection from the offset.
     if (this.closestConnection_ && this.localConnection_) {
-      return internalConstants.CONNECTING_SNAP_RADIUS;
+      return config.connectingSnapRadius;
     }
-    return internalConstants.SNAP_RADIUS;
+    return config.snapRadius;
   }
 
   /**

core/internal_constants.js

@@ -21,53 +21,6 @@ goog.module('Blockly.internalConstants');
 const {ConnectionType} = goog.require('Blockly.ConnectionType');
 
 
-/**
- * Number of pixels the mouse must move before a drag starts.
- * @alias Blockly.internalConstants.DRAG_RADIUS
- */
-const DRAG_RADIUS = 5;
-exports.DRAG_RADIUS = DRAG_RADIUS;
-
-/**
- * Number of pixels the mouse must move before a drag/scroll starts from the
- * flyout.  Because the drag-intention is determined when this is reached, it is
- * larger than DRAG_RADIUS so that the drag-direction is clearer.
- * @alias Blockly.internalConstants.FLYOUT_DRAG_RADIUS
- */
-const FLYOUT_DRAG_RADIUS = 10;
-exports.FLYOUT_DRAG_RADIUS = FLYOUT_DRAG_RADIUS;
-
-/**
- * Maximum misalignment between connections for them to snap together.
- * @alias Blockly.internalConstants.SNAP_RADIUS
- */
-const SNAP_RADIUS = 28;
-exports.SNAP_RADIUS = SNAP_RADIUS;
-
-/**
- * Maximum misalignment between connections for them to snap together,
- * when a connection is already highlighted.
- * @alias Blockly.internalConstants.CONNECTING_SNAP_RADIUS
- */
-const CONNECTING_SNAP_RADIUS = SNAP_RADIUS;
-exports.CONNECTING_SNAP_RADIUS = CONNECTING_SNAP_RADIUS;
-
-/**
- * How much to prefer staying connected to the current connection over moving to
- * a new connection.  The current previewed connection is considered to be this
- * much closer to the matching connection on the block than it actually is.
- * @alias Blockly.internalConstants.CURRENT_CONNECTION_PREFERENCE
- */
-const CURRENT_CONNECTION_PREFERENCE = 8;
-exports.CURRENT_CONNECTION_PREFERENCE = CURRENT_CONNECTION_PREFERENCE;
-
-/**
- * Delay in ms between trigger and bumping unconnected block out of alignment.
- * @alias Blockly.internalConstants.BUMP_DELAY
- */
-const BUMP_DELAY = 250;
-exports.BUMP_DELAY = BUMP_DELAY;
-
 /**
  * Number of characters to truncate a collapsed block to.
  * @alias Blockly.internalConstants.COLLAPSE_CHARS
@@ -83,50 +36,6 @@ exports.COLLAPSE_CHARS = COLLAPSE_CHARS;
 const DRAG_STACK = true;
 exports.DRAG_STACK = DRAG_STACK;
 
-/**
- * Sprited icons and images.
- * @alias Blockly.internalConstants.SPRITE
- */
-const SPRITE = {
-  width: 96,
-  height: 124,
-  url: 'sprites.png',
-};
-exports.SPRITE = SPRITE;
-
-/**
- * ENUM for no drag operation.
- * @const
- * @alias Blockly.internalConstants.DRAG_NONE
- */
-const DRAG_NONE = 0;
-exports.DRAG_NONE = DRAG_NONE;
-
-/**
- * ENUM for inside the sticky DRAG_RADIUS.
- * @const
- * @alias Blockly.internalConstants.DRAG_STICKY
- */
-const DRAG_STICKY = 1;
-exports.DRAG_STICKY = DRAG_STICKY;
-
-/**
- * ENUM for inside the non-sticky DRAG_RADIUS, for differentiating between
- * clicks and drags.
- * @const
- * @alias Blockly.internalConstants.DRAG_BEGIN
- */
-const DRAG_BEGIN = 1;
-exports.DRAG_BEGIN = DRAG_BEGIN;
-
-/**
- * ENUM for freely draggable (outside the DRAG_RADIUS, if one applies).
- * @const
- * @alias Blockly.internalConstants.DRAG_FREE
- */
-const DRAG_FREE = 2;
-exports.DRAG_FREE = DRAG_FREE;
-
 /**
  * Lookup table for determining the opposite type of a connection.
  * @const

core/mutator.js

@@ -19,7 +19,6 @@ goog.module('Blockly.Mutator');
 
 const dom = goog.require('Blockly.utils.dom');
 const eventUtils = goog.require('Blockly.Events.utils');
-const internalConstants = goog.require('Blockly.internalConstants');
 const toolbox = goog.require('Blockly.utils.toolbox');
 const xml = goog.require('Blockly.utils.xml');
 /* eslint-disable-next-line no-unused-vars */
@@ -32,6 +31,7 @@ const {BlocklyOptions} = goog.requireType('Blockly.BlocklyOptions');
 /* eslint-disable-next-line no-unused-vars */
 const {Block} = goog.requireType('Blockly.Block');
 const {Bubble} = goog.require('Blockly.Bubble');
+const {config} = goog.require('Blockly.config');
 /* eslint-disable-next-line no-unused-vars */
 const {Connection} = goog.requireType('Blockly.Connection');
 /* eslint-disable-next-line no-unused-vars */
@@ -480,7 +480,7 @@ class Mutator extends Icon {
           eventUtils.setGroup(mutationGroup);
           block.bumpNeighbours();
           eventUtils.setGroup(oldGroup);
-        }, internalConstants.BUMP_DELAY);
+        }, config.bumpDelay);
       }
 
       // Don't update the bubble until the drag has ended, to avoid moving