mirror of
https://github.com/google/blockly.git
synced 2026-01-04 15:40:08 +01:00
* refactor(events): Use "export ... from" where applicable
* refactor(events): Introduce EventType enum
Introduce an enum for the event .type values. We can't actually
use it as the type of the .type property on Abstract events,
because we want to allow developers to add their own custom
event types inheriting from this type, but at least this way we
can be reasonably sure that all of our own event subclasses have
distinct .type values—plus consistent use of enum syntax
(EventType.TYPE_NAME) is probably good for readability overall.
Put it in a separate module from the rest of events/utils.ts
because it would be helpful if event utils could use
event instanceof SomeEventType
for type narrowing but but at the moment most events are in
modules that depend on events/utils.ts for their .type
constant, and although circular ESM dependencies should work
in principle there are various restrictions and this
particular circularity causes issues at the moment.
A few of the event classes also depend on utils.ts for fire()
or other functions, which will be harder to deal with, but at
least this commit is win in terms of reducing the complexity
of our dependencies, making most of the Abstract event subclass
module dependent on type.ts, which has no imports, rather than
on utils.ts which has multiple imports.
98 lines
3.2 KiB
JavaScript
98 lines
3.2 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2019 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
import {EventType} from '../../build/src/core/events/type.js';
|
|
import {assert} from '../../node_modules/chai/chai.js';
|
|
import {defineBasicBlockWithField} from './test_helpers/block_definitions.js';
|
|
import {assertEventFired, assertEventNotFired} from './test_helpers/events.js';
|
|
import {
|
|
sharedTestSetup,
|
|
sharedTestTeardown,
|
|
} from './test_helpers/setup_teardown.js';
|
|
import {dispatchPointerEvent} from './test_helpers/user_input.js';
|
|
|
|
suite('Gesture', function () {
|
|
function testGestureIsFieldClick(block, isFieldClick, eventsFireStub) {
|
|
const field = block.getField('NAME');
|
|
const eventTarget = field.getClickTarget_();
|
|
assert.exists(eventTarget, 'Precondition: missing click target for field');
|
|
|
|
eventsFireStub.resetHistory();
|
|
dispatchPointerEvent(eventTarget, 'pointerdown');
|
|
|
|
const fieldWorkspace = field.sourceBlock_.workspace;
|
|
// Gestures triggered on flyouts are stored on targetWorkspace.
|
|
const gestureWorkspace = fieldWorkspace.targetWorkspace || fieldWorkspace;
|
|
const gesture = gestureWorkspace.currentGesture_;
|
|
assert.exists(gesture, 'Gesture exists after pointerdown.');
|
|
const isFieldClickSpy = sinon.spy(gesture, 'isFieldClick');
|
|
|
|
dispatchPointerEvent(eventTarget, 'pointerup');
|
|
dispatchPointerEvent(eventTarget, 'click');
|
|
|
|
sinon.assert.called(isFieldClickSpy);
|
|
assert.isTrue(isFieldClickSpy.alwaysReturned(isFieldClick));
|
|
|
|
assertEventFired(
|
|
eventsFireStub,
|
|
Blockly.Events.Selected,
|
|
{newElementId: block.id, type: EventType.SELECTED},
|
|
fieldWorkspace.id,
|
|
);
|
|
assertEventNotFired(eventsFireStub, Blockly.Events.Click, {
|
|
type: EventType.CLICK,
|
|
});
|
|
}
|
|
|
|
function getTopFlyoutBlock(flyout) {
|
|
return flyout.workspace_.getTopBlocks(false)[0];
|
|
}
|
|
|
|
setup(function () {
|
|
sharedTestSetup.call(this);
|
|
defineBasicBlockWithField();
|
|
const toolbox = document.getElementById('gesture-test-toolbox');
|
|
this.workspace = Blockly.inject('blocklyDiv', {toolbox: toolbox});
|
|
});
|
|
|
|
teardown(function () {
|
|
sharedTestTeardown.call(this);
|
|
});
|
|
|
|
test('Constructor', function () {
|
|
const e = {id: 'dummy_test_event'};
|
|
const gesture = new Blockly.Gesture(e, this.workspace);
|
|
assert.equal(gesture.mostRecentEvent, e);
|
|
assert.equal(gesture.creatorWorkspace, this.workspace);
|
|
});
|
|
|
|
test('Field click - Click in workspace', function () {
|
|
const block = this.workspace.newBlock('test_field_block');
|
|
block.initSvg();
|
|
block.render();
|
|
|
|
testGestureIsFieldClick(block, true, this.eventsFireStub);
|
|
});
|
|
|
|
test('Field click - Auto close flyout', function () {
|
|
const flyout = this.workspace.getFlyout(true);
|
|
assert.exists(flyout, 'Precondition: missing flyout');
|
|
flyout.autoClose = true;
|
|
|
|
const block = getTopFlyoutBlock(flyout);
|
|
testGestureIsFieldClick(block, false, this.eventsFireStub);
|
|
});
|
|
|
|
test('Field click - Always open flyout', function () {
|
|
const flyout = this.workspace.getFlyout(true);
|
|
assert.exists(flyout, 'Precondition: missing flyout');
|
|
flyout.autoClose = false;
|
|
|
|
const block = getTopFlyoutBlock(flyout);
|
|
testGestureIsFieldClick(block, true, this.eventsFireStub);
|
|
});
|
|
});
|