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.
110 lines
3.2 KiB
JavaScript
110 lines
3.2 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2021 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 {defineRowBlock} from './test_helpers/block_definitions.js';
|
|
import {assertEventFired} from './test_helpers/events.js';
|
|
import {
|
|
sharedTestSetup,
|
|
sharedTestTeardown,
|
|
} from './test_helpers/setup_teardown.js';
|
|
|
|
suite('Block Create Event', function () {
|
|
setup(function () {
|
|
sharedTestSetup.call(this);
|
|
defineRowBlock();
|
|
this.workspace = new Blockly.Workspace();
|
|
});
|
|
|
|
teardown(function () {
|
|
sharedTestTeardown.call(this);
|
|
});
|
|
|
|
test('Create shadow on disconnect', function () {
|
|
Blockly.Events.disable();
|
|
const block = Blockly.serialization.blocks.append(
|
|
{
|
|
'type': 'row_block',
|
|
'inputs': {
|
|
'INPUT': {
|
|
'shadow': {
|
|
'type': 'row_block',
|
|
'id': 'shadowId',
|
|
},
|
|
'block': {
|
|
'type': 'row_block',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
this.workspace,
|
|
);
|
|
Blockly.Events.enable();
|
|
block.getInput('INPUT').connection.disconnect();
|
|
assertEventFired(
|
|
this.eventsFireStub,
|
|
Blockly.Events.BlockCreate,
|
|
{'recordUndo': false, 'type': EventType.BLOCK_CREATE},
|
|
this.workspace.id,
|
|
'shadowId',
|
|
);
|
|
const calls = this.eventsFireStub.getCalls();
|
|
const event = calls[calls.length - 1].args[0];
|
|
assert.equal(event.xml.tagName, 'shadow');
|
|
});
|
|
|
|
test('Does not create extra shadow blocks', function () {
|
|
const shadowId = 'shadow_block';
|
|
const blockJson = {
|
|
'type': 'math_arithmetic',
|
|
'id': 'parent_with_shadow',
|
|
'fields': {'OP': 'ADD'},
|
|
'inputs': {
|
|
'A': {
|
|
'shadow': {
|
|
'type': 'math_number',
|
|
'id': shadowId,
|
|
'fields': {'NUM': 1},
|
|
},
|
|
},
|
|
},
|
|
};
|
|
|
|
// If there is a shadow block on the workspace and then we get
|
|
// a block create event with the same ID as the shadow block,
|
|
// this represents a block that had been covering a shadow block
|
|
// being removed.
|
|
Blockly.serialization.blocks.append(blockJson, this.workspace);
|
|
const shadowBlock = this.workspace.getBlockById(shadowId);
|
|
const blocksBefore = this.workspace.getAllBlocks();
|
|
|
|
const event = new Blockly.Events.BlockCreate(shadowBlock);
|
|
event.run(true);
|
|
|
|
const blocksAfter = this.workspace.getAllBlocks();
|
|
assert.deepEqual(
|
|
blocksAfter,
|
|
blocksBefore,
|
|
'No new blocks should be created from an event that only creates shadow blocks',
|
|
);
|
|
});
|
|
|
|
suite('Serialization', function () {
|
|
test('events round-trip through JSON', function () {
|
|
const block = this.workspace.newBlock('row_block', 'block_id');
|
|
const origEvent = new Blockly.Events.BlockCreate(block);
|
|
|
|
const json = origEvent.toJson();
|
|
const newEvent = new Blockly.Events.fromJson(json, this.workspace);
|
|
delete origEvent.xml; // xml fails deep equals for some reason.
|
|
delete newEvent.xml; // xml fails deep equals for some reason.
|
|
|
|
assert.deepEqual(newEvent, origEvent);
|
|
});
|
|
});
|
|
});
|