mirror of
https://github.com/google/blockly.git
synced 2026-01-05 08:00:09 +01:00
7ccdcc5cef
* 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.
377 lines
12 KiB
JavaScript
377 lines
12 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2019 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
import {EventType} from '../../build/src/core/events/type.js';
|
|
import * as eventUtils from '../../build/src/core/events/utils.js';
|
|
import {assert} from '../../node_modules/chai/chai.js';
|
|
import {
|
|
defineBasicBlockWithField,
|
|
defineMutatorBlocks,
|
|
defineRowBlock,
|
|
defineStackBlock,
|
|
defineStatementBlock,
|
|
} from './test_helpers/block_definitions.js';
|
|
import {assertEventFired, assertEventNotFired} from './test_helpers/events.js';
|
|
import {
|
|
sharedTestSetup,
|
|
sharedTestTeardown,
|
|
} from './test_helpers/setup_teardown.js';
|
|
import {simulateClick} from './test_helpers/user_input.js';
|
|
|
|
suite('Trashcan', function () {
|
|
function fireDeleteEvent(workspace, xmlString) {
|
|
let xml = Blockly.utils.xml.textToDom(
|
|
'<xml xmlns="https://developers.google.com/blockly/xml">' +
|
|
xmlString +
|
|
'</xml>',
|
|
);
|
|
xml = xml.children[0];
|
|
const block = Blockly.Xml.domToBlock(xml, workspace);
|
|
const event = new Blockly.Events.BlockDelete(block);
|
|
eventUtils.fire(event);
|
|
}
|
|
function fireNonDeleteEvent(workspace, oldXml) {
|
|
const event = new Blockly.Events.Abstract();
|
|
event.type = 'test_field_block';
|
|
event.workspaceId = workspace.id;
|
|
if (oldXml) {
|
|
event.oldXml = oldXml;
|
|
}
|
|
eventUtils.fire(/** @type {Blockly.Events.Abstract} */ event);
|
|
}
|
|
|
|
setup(function () {
|
|
sharedTestSetup.call(this);
|
|
defineBasicBlockWithField();
|
|
defineRowBlock();
|
|
defineRowBlock('row_block2');
|
|
defineStatementBlock();
|
|
defineStatementBlock('statement_block2');
|
|
defineStackBlock();
|
|
defineStackBlock('stack_block2');
|
|
defineMutatorBlocks();
|
|
this.workspace = Blockly.inject('blocklyDiv', {
|
|
'trashcan': true,
|
|
'maxTrashcanContents': Infinity,
|
|
});
|
|
this.trashcan = this.workspace.trashcan;
|
|
});
|
|
teardown(function () {
|
|
sharedTestTeardown.call(this);
|
|
Blockly.Extensions.unregister('xml_mutator');
|
|
Blockly.Extensions.unregister('jso_mutator');
|
|
});
|
|
|
|
suite('Events', function () {
|
|
test('Delete', function () {
|
|
fireDeleteEvent(this.workspace, '<block type="test_field_block"/>');
|
|
assert.equal(this.trashcan.contents.length, 1);
|
|
});
|
|
test('Non-Delete', function () {
|
|
fireNonDeleteEvent(this.workspace);
|
|
assert.equal(this.trashcan.contents.length, 0);
|
|
});
|
|
test('Non-Delete w/ oldXml', function () {
|
|
let xml = Blockly.utils.xml.textToDom(
|
|
'<xml xmlns="https://developers.google.com/blockly/xml">' +
|
|
' <block type="test_field_block"/>' +
|
|
'</xml>',
|
|
);
|
|
xml = xml.children[0];
|
|
fireNonDeleteEvent(this.workspace, xml);
|
|
assert.equal(this.trashcan.contents.length, 0);
|
|
});
|
|
test('Shadow Delete', function () {
|
|
fireDeleteEvent(this.workspace, '<shadow type="test_field_block"/>');
|
|
assert.equal(this.trashcan.contents.length, 0);
|
|
});
|
|
test('Click without contents - fires workspace click', function () {
|
|
simulateClick(this.trashcan.svgGroup);
|
|
|
|
assertEventNotFired(this.eventsFireStub, Blockly.Events.TrashcanOpen, {
|
|
type: EventType.CLICK,
|
|
});
|
|
assertEventFired(
|
|
this.eventsFireStub,
|
|
Blockly.Events.Click,
|
|
{targetType: 'workspace', type: EventType.CLICK},
|
|
this.workspace.id,
|
|
undefined,
|
|
);
|
|
});
|
|
test('Click with contents - fires trashcanOpen', function () {
|
|
fireDeleteEvent(this.workspace, '<block type="test_field_block"/>');
|
|
assert.equal(this.trashcan.contents.length, 1);
|
|
// Stub flyout interaction.
|
|
const showFlyoutStub = sinon.stub(this.trashcan.flyout, 'show');
|
|
|
|
simulateClick(this.trashcan.svgGroup);
|
|
|
|
sinon.assert.calledOnce(showFlyoutStub);
|
|
|
|
assertEventFired(
|
|
this.eventsFireStub,
|
|
Blockly.Events.TrashcanOpen,
|
|
{isOpen: true, type: EventType.TRASHCAN_OPEN},
|
|
this.workspace.id,
|
|
);
|
|
assertEventNotFired(this.eventsFireStub, Blockly.Events.Click, {
|
|
type: EventType.TRASHCAN_OPEN,
|
|
});
|
|
});
|
|
test('Click outside trashcan - fires trashcanClose', function () {
|
|
this.trashcan.flyout.setVisible(true);
|
|
|
|
simulateClick(this.workspace.svgGroup_);
|
|
|
|
assert.isFalse(
|
|
this.trashcan.flyout.isVisible(),
|
|
'Expected flyout to be hidden',
|
|
);
|
|
assertEventFired(
|
|
this.eventsFireStub,
|
|
Blockly.Events.TrashcanOpen,
|
|
{isOpen: false, type: EventType.TRASHCAN_OPEN},
|
|
this.workspace.id,
|
|
);
|
|
assertEventFired(
|
|
this.eventsFireStub,
|
|
Blockly.Events.Click,
|
|
{targetType: 'workspace', type: EventType.CLICK},
|
|
this.workspace.id,
|
|
undefined,
|
|
);
|
|
});
|
|
});
|
|
suite('Unique Contents', function () {
|
|
test('Simple', function () {
|
|
fireDeleteEvent(this.workspace, '<block type="test_field_block"/>');
|
|
fireDeleteEvent(this.workspace, '<block type="test_field_block"/>');
|
|
assert.equal(this.trashcan.contents.length, 1);
|
|
});
|
|
test('Different Coords', function () {
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="test_field_block" x="10" y="10"/>',
|
|
);
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="test_field_block" x="20" y="20"/>',
|
|
);
|
|
assert.equal(this.trashcan.contents.length, 1);
|
|
});
|
|
test('Different IDs', function () {
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="test_field_block" id="id1"/>',
|
|
);
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="test_field_block" id="id2"/>',
|
|
);
|
|
assert.equal(this.trashcan.contents.length, 1);
|
|
});
|
|
test('No Disabled - Disabled True', function () {
|
|
fireDeleteEvent(this.workspace, '<block type="test_field_block"/>');
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="test_field_block" disabled="true"/>',
|
|
);
|
|
// Disabled tags get removed because disabled blocks aren't allowed to
|
|
// be dragged from flyouts. See #2239 and #3243.
|
|
assert.equal(this.trashcan.contents.length, 1);
|
|
});
|
|
test('Different Field Values', function () {
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="test_field_block">' +
|
|
' <field name="NAME">dummy_value1</field>' +
|
|
'</block>',
|
|
);
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="test_field_block">' +
|
|
' <field name="NAME">dummy_value2</field>' +
|
|
'</block>',
|
|
);
|
|
assert.equal(this.trashcan.contents.length, 2);
|
|
});
|
|
test('No Values - Values', function () {
|
|
fireDeleteEvent(this.workspace, '<block type="row_block"/>');
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="row_block">' +
|
|
' <value name="INPUT">' +
|
|
' <block type="row_block"/>' +
|
|
' </value>' +
|
|
'</block>',
|
|
);
|
|
assert.equal(this.trashcan.contents.length, 2);
|
|
});
|
|
test('Different Value Blocks', function () {
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="row_block">' +
|
|
' <value name="INPUT">' +
|
|
' <block type="row_block"/>' +
|
|
' </value>' +
|
|
'</block>',
|
|
);
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="row_block">' +
|
|
' <value name="INPUT">' +
|
|
' <block type="row_block2"/>' +
|
|
' </value>' +
|
|
'</block>',
|
|
);
|
|
assert.equal(this.trashcan.contents.length, 2);
|
|
});
|
|
test('No Statements - Statements', function () {
|
|
fireDeleteEvent(this.workspace, '<block type="statement_block"/>');
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="statement_block">' +
|
|
' <statement name="NAME">' +
|
|
' <block type="statement_block"/>' +
|
|
' </statement>' +
|
|
'</block>',
|
|
);
|
|
assert.equal(this.trashcan.contents.length, 2);
|
|
});
|
|
test('Different Statement Blocks', function () {
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="statement_block">' +
|
|
' <statement name="NAME">' +
|
|
' <block type="statement_block"/>' +
|
|
' </statement>' +
|
|
'</block>',
|
|
);
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="statement_block2">' +
|
|
' <statement name="NAME">' +
|
|
' <block type="statement_block2"/>' +
|
|
' </statement>' +
|
|
'</block>',
|
|
);
|
|
assert.equal(this.trashcan.contents.length, 2);
|
|
});
|
|
test('No Next - Next', function () {
|
|
fireDeleteEvent(this.workspace, '<block type="stack_block"/>');
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="stack_block">' +
|
|
' <next>' +
|
|
' <block type="stack_block"/>' +
|
|
' </next>' +
|
|
'</block>',
|
|
);
|
|
assert.equal(this.trashcan.contents.length, 2);
|
|
});
|
|
test('Different Next Blocks', function () {
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="stack_block">' +
|
|
' <next>' +
|
|
' <block type="stack_block"/>' +
|
|
' </next>' +
|
|
'</block>',
|
|
);
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="stack_block">' +
|
|
' <next>' +
|
|
' <block type="stack_block2"/>' +
|
|
' </next>' +
|
|
'</block>',
|
|
);
|
|
assert.equal(this.trashcan.contents.length, 2);
|
|
});
|
|
test('No Comment - Comment', function () {
|
|
fireDeleteEvent(this.workspace, '<block type="test_field_block"/>');
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="test_field_block">' +
|
|
' <comment>comment_text</comment>' +
|
|
'</block>',
|
|
);
|
|
assert.equal(this.trashcan.contents.length, 2);
|
|
});
|
|
test('Different Comment Text', function () {
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="test_field_block">' +
|
|
' <comment>comment_text1</comment>' +
|
|
'</block>',
|
|
);
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="test_field_block">' +
|
|
' <comment>comment_text2</comment>' +
|
|
'</block>',
|
|
);
|
|
assert.equal(this.trashcan.contents.length, 2);
|
|
});
|
|
test('Different Comment Size', function () {
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="test_field_block">' +
|
|
' <comment h="10" w="10">comment_text</comment>' +
|
|
'</block>',
|
|
);
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="test_field_block">' +
|
|
' <comment h="20" w="20">comment_text</comment>' +
|
|
'</block>',
|
|
);
|
|
// h & w tags are removed b/c the blocks appear the same.
|
|
assert.equal(this.trashcan.contents.length, 1);
|
|
});
|
|
test('Different Comment Pinned', function () {
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="test_field_block">' +
|
|
' <comment pinned="false">comment_text</comment>' +
|
|
'</block>',
|
|
);
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="test_field_block">' +
|
|
' <comment pinned="true">comment_text</comment>' +
|
|
'</block>',
|
|
);
|
|
// pinned tags are removed b/c the blocks appear the same.
|
|
assert.equal(this.trashcan.contents.length, 1);
|
|
});
|
|
test('Different Mutator', function () {
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="xml_block">' +
|
|
' <mutation hasInput="true"></mutation>' +
|
|
'</block>',
|
|
);
|
|
fireDeleteEvent(
|
|
this.workspace,
|
|
'<block type="xml_block">' +
|
|
' <mutation hasInputt="false"></mutation>' +
|
|
'</block>',
|
|
);
|
|
assert.equal(this.trashcan.contents.length, 2);
|
|
});
|
|
});
|
|
suite('Max Contents', function () {
|
|
test('Max 0', function () {
|
|
this.workspace.options.maxTrashcanContents = 0;
|
|
fireDeleteEvent(this.workspace, '<block type="test_field_block"/>');
|
|
assert.equal(this.trashcan.contents.length, 0);
|
|
this.workspace.options.maxTrashcanContents = Infinity;
|
|
});
|
|
});
|
|
});
|