/** * @license * Copyright 2019 Google LLC * SPDX-License-Identifier: Apache-2.0 */ import {assertEventFired, assertEventNotFired} from './test_helpers/events.js'; import { sharedTestSetup, sharedTestTeardown, } from './test_helpers/setup_teardown.js'; import { defineBasicBlockWithField, defineMutatorBlocks, defineRowBlock, defineStackBlock, defineStatementBlock, } from './test_helpers/block_definitions.js'; import * as eventUtils from '../../build/src/core/events/utils.js'; import {simulateClick} from './test_helpers/user_input.js'; suite('Trashcan', function () { function fireDeleteEvent(workspace, xmlString) { let xml = Blockly.utils.xml.textToDom( '' + xmlString + '', ); 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, ''); chai.assert.equal(this.trashcan.contents.length, 1); }); test('Non-Delete', function () { fireNonDeleteEvent(this.workspace); chai.assert.equal(this.trashcan.contents.length, 0); }); test('Non-Delete w/ oldXml', function () { let xml = Blockly.utils.xml.textToDom( '' + ' ' + '', ); xml = xml.children[0]; fireNonDeleteEvent(this.workspace, xml); chai.assert.equal(this.trashcan.contents.length, 0); }); test('Shadow Delete', function () { fireDeleteEvent(this.workspace, ''); chai.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: eventUtils.CLICK, }); assertEventFired( this.eventsFireStub, Blockly.Events.Click, {targetType: 'workspace', type: eventUtils.CLICK}, this.workspace.id, undefined, ); }); test('Click with contents - fires trashcanOpen', function () { fireDeleteEvent(this.workspace, ''); chai.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: eventUtils.TRASHCAN_OPEN}, this.workspace.id, ); assertEventNotFired(this.eventsFireStub, Blockly.Events.Click, { type: eventUtils.TRASHCAN_OPEN, }); }); test('Click outside trashcan - fires trashcanClose', function () { this.trashcan.flyout.setVisible(true); simulateClick(this.workspace.svgGroup_); chai.assert.isFalse( this.trashcan.flyout.isVisible(), 'Expected flyout to be hidden', ); assertEventFired( this.eventsFireStub, Blockly.Events.TrashcanOpen, {isOpen: false, type: eventUtils.TRASHCAN_OPEN}, this.workspace.id, ); assertEventFired( this.eventsFireStub, Blockly.Events.Click, {targetType: 'workspace', type: eventUtils.CLICK}, this.workspace.id, undefined, ); }); }); suite('Unique Contents', function () { test('Simple', function () { fireDeleteEvent(this.workspace, ''); fireDeleteEvent(this.workspace, ''); chai.assert.equal(this.trashcan.contents.length, 1); }); test('Different Coords', function () { fireDeleteEvent( this.workspace, '', ); fireDeleteEvent( this.workspace, '', ); chai.assert.equal(this.trashcan.contents.length, 1); }); test('Different IDs', function () { fireDeleteEvent( this.workspace, '', ); fireDeleteEvent( this.workspace, '', ); chai.assert.equal(this.trashcan.contents.length, 1); }); test('No Disabled - Disabled True', function () { fireDeleteEvent(this.workspace, ''); fireDeleteEvent( this.workspace, '', ); // Disabled tags get removed because disabled blocks aren't allowed to // be dragged from flyouts. See #2239 and #3243. chai.assert.equal(this.trashcan.contents.length, 1); }); test('Different Field Values', function () { fireDeleteEvent( this.workspace, '' + ' dummy_value1' + '', ); fireDeleteEvent( this.workspace, '' + ' dummy_value2' + '', ); chai.assert.equal(this.trashcan.contents.length, 2); }); test('No Values - Values', function () { fireDeleteEvent(this.workspace, ''); fireDeleteEvent( this.workspace, '' + ' ' + ' ' + ' ' + '', ); chai.assert.equal(this.trashcan.contents.length, 2); }); test('Different Value Blocks', function () { fireDeleteEvent( this.workspace, '' + ' ' + ' ' + ' ' + '', ); fireDeleteEvent( this.workspace, '' + ' ' + ' ' + ' ' + '', ); chai.assert.equal(this.trashcan.contents.length, 2); }); test('No Statements - Statements', function () { fireDeleteEvent(this.workspace, ''); fireDeleteEvent( this.workspace, '' + ' ' + ' ' + ' ' + '', ); chai.assert.equal(this.trashcan.contents.length, 2); }); test('Different Statement Blocks', function () { fireDeleteEvent( this.workspace, '' + ' ' + ' ' + ' ' + '', ); fireDeleteEvent( this.workspace, '' + ' ' + ' ' + ' ' + '', ); chai.assert.equal(this.trashcan.contents.length, 2); }); test('No Next - Next', function () { fireDeleteEvent(this.workspace, ''); fireDeleteEvent( this.workspace, '' + ' ' + ' ' + ' ' + '', ); chai.assert.equal(this.trashcan.contents.length, 2); }); test('Different Next Blocks', function () { fireDeleteEvent( this.workspace, '' + ' ' + ' ' + ' ' + '', ); fireDeleteEvent( this.workspace, '' + ' ' + ' ' + ' ' + '', ); chai.assert.equal(this.trashcan.contents.length, 2); }); test('No Comment - Comment', function () { fireDeleteEvent(this.workspace, ''); fireDeleteEvent( this.workspace, '' + ' comment_text' + '', ); chai.assert.equal(this.trashcan.contents.length, 2); }); test('Different Comment Text', function () { fireDeleteEvent( this.workspace, '' + ' comment_text1' + '', ); fireDeleteEvent( this.workspace, '' + ' comment_text2' + '', ); chai.assert.equal(this.trashcan.contents.length, 2); }); test('Different Comment Size', function () { fireDeleteEvent( this.workspace, '' + ' comment_text' + '', ); fireDeleteEvent( this.workspace, '' + ' comment_text' + '', ); // h & w tags are removed b/c the blocks appear the same. chai.assert.equal(this.trashcan.contents.length, 1); }); test('Different Comment Pinned', function () { fireDeleteEvent( this.workspace, '' + ' comment_text' + '', ); fireDeleteEvent( this.workspace, '' + ' comment_text' + '', ); // pinned tags are removed b/c the blocks appear the same. chai.assert.equal(this.trashcan.contents.length, 1); }); test('Different Mutator', function () { fireDeleteEvent( this.workspace, '' + ' ' + '', ); fireDeleteEvent( this.workspace, '' + ' ' + '', ); chai.assert.equal(this.trashcan.contents.length, 2); }); }); suite('Max Contents', function () { test('Max 0', function () { this.workspace.options.maxTrashcanContents = 0; fireDeleteEvent(this.workspace, ''); chai.assert.equal(this.trashcan.contents.length, 0); this.workspace.options.maxTrashcanContents = Infinity; }); }); });