blockly/tests/mocha/jso_serialization_test.js

/**
 * @license
 * Copyright 2021 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */

goog.module('Blockly.test.jsoSerialization');

const {defineStackBlock, defineRowBlock, defineStatementBlock, createGenUidStubWithReturns, sharedTestSetup, sharedTestTeardown, workspaceTeardown} = goog.require('Blockly.test.helpers');


suite('JSO Serialization', function() {
  setup(function() {
    sharedTestSetup.call(this);
    this.workspace = new Blockly.Workspace();

    defineStackBlock();
    defineRowBlock();
    defineStatementBlock();

    createGenUidStubWithReturns(new Array(10).fill().map((_, i) => 'id' + i));
  });

  teardown(function() {
    workspaceTeardown.call(this, this.workspace);
    sharedTestTeardown.call(this);
  });

  function assertProperty(obj, property, value) {
    chai.assert.deepEqual(obj[property], value);
  }

  function assertNoProperty(obj, property) {
    assertProperty(obj, property, undefined);
  }


  suite('Blocks', function() {
    test('Null on insertionMarkers', function() {
      const block = this.workspace.newBlock('row_block');
      block.setInsertionMarker(true);
      const jso = Blockly.serialization.blocks.save(block);
      chai.assert.isNull(jso);
    });

    test('Basic', function() {
      const block = this.workspace.newBlock('row_block');
      const jso = Blockly.serialization.blocks.save(block);
      assertProperty(jso, 'type', 'row_block');
      assertProperty(jso, 'id', 'id0');
    });

    suite('Attributes', function() {
      suite('Collapsed', function() {
        test('True', function() {
          const block = this.workspace.newBlock('row_block');
          block.setCollapsed(true);
          const jso = Blockly.serialization.blocks.save(block);
          assertProperty(jso, 'collapsed', true);
        });

        test('False', function() {
          const block = this.workspace.newBlock('row_block');
          block.setCollapsed(false);
          const jso = Blockly.serialization.blocks.save(block);
          assertNoProperty(jso, 'collapsed');
        });
      });

      suite('Enabled', function() {
        test('False', function() {
          const block = this.workspace.newBlock('row_block');
          block.setEnabled(false);
          const jso = Blockly.serialization.blocks.save(block);
          assertProperty(jso, 'enabled', false);
        });

        test('True', function() {
          const block = this.workspace.newBlock('row_block');
          block.setEnabled(true);
          const jso = Blockly.serialization.blocks.save(block);
          assertNoProperty(jso, 'enabled');
        });
      });

      suite('Deletable', function() {
        test('False', function() {
          const block = this.workspace.newBlock('row_block');
          block.setDeletable(false);
          const jso = Blockly.serialization.blocks.save(block);
          assertProperty(jso, 'deletable', false);
        });

        test('True', function() {
          const block = this.workspace.newBlock('row_block');
          block.setDeletable(true);
          const jso = Blockly.serialization.blocks.save(block);
          assertNoProperty(jso, 'deletable');
        });

        test('False and Shadow', function() {
          const block = this.workspace.newBlock('row_block');
          block.setDeletable(false);
          block.setShadow(true);
          const jso = Blockly.serialization.blocks.save(block);
          assertNoProperty(jso, 'deletable');
        });
      });

      suite('Movable', function() {
        test('False', function() {
          const block = this.workspace.newBlock('row_block');
          block.setMovable(false);
          const jso = Blockly.serialization.blocks.save(block);
          assertProperty(jso, 'movable', false);
        });

        test('True', function() {
          const block = this.workspace.newBlock('row_block');
          block.setMovable(true);
          const jso = Blockly.serialization.blocks.save(block);
          assertNoProperty(jso, 'movable');
        });

        test('False and Shadow', function() {
          const block = this.workspace.newBlock('row_block');
          block.setMovable(false);
          block.setShadow(true);
          const jso = Blockly.serialization.blocks.save(block);
          assertNoProperty(jso, 'movable');
        });
      });

      suite('Editable', function() {
        test('False', function() {
          const block = this.workspace.newBlock('row_block');
          block.setEditable(false);
          const jso = Blockly.serialization.blocks.save(block);
          assertProperty(jso, 'editable', false);
        });

        test('True', function() {
          const block = this.workspace.newBlock('row_block');
          block.setEditable(true);
          const jso = Blockly.serialization.blocks.save(block);
          assertNoProperty(jso, 'editable');
        });
      });

      suite('Inline', function() {
        test('True', function() {
          const block = this.workspace.newBlock('statement_block');
          block.setInputsInline(true);
          const jso = Blockly.serialization.blocks.save(block);
          assertProperty(jso, 'inline', true);
        });

        test('False', function() {
          const block = this.workspace.newBlock('statement_block');
          block.setInputsInline(false);
          const jso = Blockly.serialization.blocks.save(block);
          assertProperty(jso, 'inline', false);
        });

        test('undefined', function() {
          const block = this.workspace.newBlock('statement_block');
          const jso = Blockly.serialization.blocks.save(block);
          assertNoProperty(jso, 'inline');
        });

        test('True, matching default', function() {
          const block = this.workspace.newBlock('statement_block');
          block.setInputsInline(true);
          block.inputsInlineDefault = true;
          const jso = Blockly.serialization.blocks.save(block);
          assertNoProperty(jso, 'inline');
        });

        test('False, matching default', function() {
          const block = this.workspace.newBlock('statement_block');
          block.setInputsInline(false);
          block.inputsInlineDefault = false;
          const jso = Blockly.serialization.blocks.save(block);
          assertNoProperty(jso, 'inline');
        });
      });

      suite('Data', function() {
        test('No data', function() {
          const block = this.workspace.newBlock('row_block');
          const jso = Blockly.serialization.blocks.save(block);
          assertNoProperty(jso, 'data');
        });

        test('With data', function() {
          const block = this.workspace.newBlock('row_block');
          block.data = 'some data';
          const jso = Blockly.serialization.blocks.save(block);
          assertProperty(jso, 'data', 'some data');
        });
      });
    });

    suite('Coords', function() {
      test('No coordinates', function() {
        const block = this.workspace.newBlock('row_block');
        const jso = Blockly.serialization.blocks.save(block);
        assertNoProperty(jso, 'x');
        assertNoProperty(jso, 'y');
      });

      test('Simple', function() {
        const block = this.workspace.newBlock('row_block');
        block.moveBy(42, 42);
        const jso =
            Blockly.serialization.blocks.save(block, {addCoordinates: true});
        assertProperty(jso, 'x', 42);
        assertProperty(jso, 'y', 42);
      });

      test('Negative', function() {
        const block = this.workspace.newBlock('row_block');
        block.moveBy(-42, -42);
        const jso =
            Blockly.serialization.blocks.save(block, {addCoordinates: true});
        assertProperty(jso, 'x', -42);
        assertProperty(jso, 'y', -42);
      });

      test('Zero', function() {
        const block = this.workspace.newBlock('row_block');
        const jso =
            Blockly.serialization.blocks.save(block, {addCoordinates: true});
        assertProperty(jso, 'x', 0);
        assertProperty(jso, 'y', 0);
      });
    });

    // Mutators.
    suite('Extra state', function() {
      test('Simple value', function() {
        const block = this.workspace.newBlock('row_block');
        block.saveExtraState = function() {
          return 'some extra state';
        };
        const jso = Blockly.serialization.blocks.save(block);
        assertProperty(jso, 'extraState', 'some extra state');
      });

      test('Object', function() {
        const block = this.workspace.newBlock('row_block');
        block.saveExtraState = function() {
          return {
            'extra1': 'state1',
            'extra2': 42,
            'extra3': true,
          };
        };
        const jso = Blockly.serialization.blocks.save(block);
        assertProperty(jso, 'extraState', {
          'extra1': 'state1',
          'extra2': 42,
          'extra3': true,
        });
      });

      test('Array', function() {
        const block = this.workspace.newBlock('row_block');
        block.saveExtraState = function() {
          return ['state1', 42, true];
        };
        const jso = Blockly.serialization.blocks.save(block);
        assertProperty(jso, 'extraState', ['state1', 42, true]);
      });
    });

    suite('Icons', function() {
      suite('Comment', function() {
        test('Basic', function() {
          const block = this.workspace.newBlock('row_block');
          block.setCommentText('test');
          const jso = Blockly.serialization.blocks.save(block);
          assertProperty(
              jso,
              'icons',
              {
                'comment': {
                  'text': 'test',
                  'pinned': false,
                  'height': 80,
                  'width': 160,
                }
              },
          );
        });

        test('Pinned', function() {
          const block = this.workspace.newBlock('row_block');
          block.setCommentText('test');
          block.commentModel.pinned = true;
          const jso = Blockly.serialization.blocks.save(block);
          assertProperty(
              jso,
              'icons',
              {
                'comment': {
                  'text': 'test',
                  'pinned': true,
                  'height': 80,
                  'width': 160,
                }
              },
          );
        });

        test('Size', function() {
          const block = this.workspace.newBlock('row_block');
          block.setCommentText('test');
          block.commentModel.size.height = 40;
          block.commentModel.size.width = 320;
          const jso = Blockly.serialization.blocks.save(block);
          assertProperty(
              jso,
              'icons',
              {
                'comment': {
                  'text': 'test',
                  'pinned': false,
                  'height': 40,
                  'width': 320,
                }
              },
          );
        });
      });
    });

    suite('Fields', function() {
      class StringStateField extends Blockly.Field {
        constructor(value, validator = undefined, config = undefined) {
          super(value, validator, config);
          this.SERIALIZABLE = true;
        }

        saveState() {
          return 'some state';
        }
      }

      class ObjectStateField extends Blockly.Field {
        constructor(value, validator = undefined, config = undefined) {
          super(value, validator, config);
          this.SERIALIZABLE = true;
        }

        saveState() {
          return {
            'prop1': 'state1',
            'prop2': 42,
            'prop3': true,
          };
        }
      }

      class ArrayStateField extends Blockly.Field {
        constructor(value, validator = undefined, config = undefined) {
          super(value, validator, config);
          this.SERIALIZABLE = true;
        }

        saveState() {
          return ['state1', 42, true];
        }
      }

      class XmlStateField extends Blockly.Field {
        constructor(value, validator = undefined, config = undefined) {
          super(value, validator, config);
          this.SERIALIZABLE = true;
        }
      }

      test('Simple value', function() {
        const block = this.workspace.newBlock('row_block');
        block.getInput('INPUT').appendField(new StringStateField(''), 'FIELD');
        const jso = Blockly.serialization.blocks.save(block);
        assertProperty(jso, 'fields', {'FIELD': 'some state'});
      });

      test('Object', function() {
        const block = this.workspace.newBlock('row_block');
        block.getInput('INPUT').appendField(new ObjectStateField(''), 'FIELD');
        const jso = Blockly.serialization.blocks.save(block);
        assertProperty(jso, 'fields', {'FIELD': {
          'prop1': 'state1',
          'prop2': 42,
          'prop3': true,
        }});
      });

      test('Array', function() {
        const block = this.workspace.newBlock('row_block');
        block.getInput('INPUT').appendField(new ArrayStateField(''), 'FIELD');
        const jso = Blockly.serialization.blocks.save(block);
        assertProperty(jso, 'fields', {'FIELD': ['state1', 42, true]});
      });
    });

    suite('Connected blocks', function() {
      setup(function() {
        this.assertInput = function(jso, name, value) {
          chai.assert.deepInclude(jso['inputs'][name], value);
        };

        this.createBlockWithChild = function(blockType, inputName) {
          const block = this.workspace.newBlock(blockType);
          const childBlock = this.workspace.newBlock(blockType);
          block.getInput(inputName).connection.connect(
              childBlock.outputConnection || childBlock.previousConnection);
          return block;
        };

        this.createBlockWithShadow = function(blockType, inputName) {
          const block = this.workspace.newBlock(blockType);
          block.getInput(inputName).connection.setShadowDom(
              Blockly.Xml.textToDom(
                  '<block type="' + blockType + '" id="test"></block>'));
          return block;
        };

        this.createBlockWithShadowAndChild = function(blockType, inputName) {
          const block = this.workspace.newBlock(blockType);
          const childBlock = this.workspace.newBlock(blockType);
          block.getInput(inputName).connection.connect(
              childBlock.outputConnection || childBlock.previousConnection);
          block.getInput(inputName).connection.setShadowDom(
              Blockly.Xml.textToDom(
                  '<block type="' + blockType + '" id="test"></block>'));
          return block;
        };
  
        this.assertChild = function(blockType, inputName) {
          const block = this.createBlockWithChild(blockType, inputName);
          const jso = Blockly.serialization.blocks.save(block);
          this.assertInput(
              jso, inputName, {'block': { 'type': blockType, 'id': 'id2'}});
        };
  
        this.assertShadow = function(blockType, inputName) {
          const block = this.createBlockWithShadow(blockType, inputName);
          const jso = Blockly.serialization.blocks.save(block);
          this.assertInput(
              jso, inputName, {'shadow': { 'type': blockType, 'id': 'test'}});
        };
  
        this.assertOverwrittenShadow = function(blockType, inputName) {
          const block =
              this.createBlockWithShadowAndChild(blockType, inputName);
          const jso = Blockly.serialization.blocks.save(block);
          this.assertInput(
              jso,
              inputName,
              {
                'block': {
                  'type': blockType,
                  'id': 'id2'
                },
                'shadow': {
                  'type': blockType,
                  'id': 'test'
                }
              });
        };

        this.assertNoChild = function(blockType, inputName) {
          const block = this.createBlockWithChild(blockType, inputName);
          const jso =
              Blockly.serialization.blocks.save(block, {addInputBlocks: false});
          chai.assert.isUndefined(jso['inputs']);
        };
  
        this.assertNoShadow = function(blockType, inputName) {
          const block = this.createBlockWithShadow(blockType, inputName);
          const jso =
              Blockly.serialization.blocks.save(block, {addInputBlocks: false});
          chai.assert.isUndefined(jso['inputs']);
        };
  
        this.assertNoOverwrittenShadow = function(blockType, inputName) {
          const block =
              this.createBlockWithShadowAndChild(blockType, inputName);
          const jso =
              Blockly.serialization.blocks.save(block, {addInputBlocks: false});
          chai.assert.isUndefined(jso['inputs']);
        };
      });

      suite('Value', function() {
        suite('With serialization', function() {
          test('Child', function() {
            this.assertChild('row_block', 'INPUT');
          });
  
          test.skip('Shadow', function() {
            this.assertShadow('row_block', 'INPUT');
          });
  
          test.skip('Overwritten shadow', function() {
            this.assertOverwrittenShadow('row_block', 'INPUT');
          });
        });

        suite('Without serialization', function() {
          test('Child', function() {
            this.assertNoChild('row_block', 'INPUT');
          });
  
          test('Shadow', function() {
            this.assertNoShadow('row_block', 'INPUT');
          });
  
          test('Overwritten shadow', function() {
            this.assertNoOverwrittenShadow('row_block', 'INPUT');
          });
        });
      });

      suite('Statement', function() {
        suite('With serialization', function() {
          test('Child', function() {
            this.assertChild('statement_block', 'NAME');
          });
  
          test.skip('Shadow', function() {
            this.assertShadow('statement_block', 'NAME');
          });
  
          test.skip('Overwritten shadow', function() {
            this.assertOverwrittenShadow('statement_block', 'NAME');
          });

          test('Child with next blocks', function() {
            const block = this.workspace.newBlock('statement_block');
            const childBlock = this.workspace.newBlock('stack_block');
            const grandChildBlock = this.workspace.newBlock('stack_block');
            block.getInput('NAME').connection
                .connect(childBlock.previousConnection);
            childBlock.nextConnection
                .connect(grandChildBlock.previousConnection);
            const jso = Blockly.serialization.blocks.save(block);
            this.assertInput(
                jso,
                'NAME',
                {
                  'block': {
                    'type': 'stack_block',
                    'id': 'id2',
                    'next': {
                      'block': {
                        'type': 'stack_block',
                        'id': 'id4'
                      }
                    }
                  }
                }
            );
          });
        });

        suite('Without serialization', function() {
          test('Child', function() {
            this.assertNoChild('statement_block', 'NAME');
          });
  
          test('Shadow', function() {
            this.assertNoShadow('statement_block', 'NAME');
          });
  
          test('Overwritten shadow', function() {
            this.assertNoOverwrittenShadow('statement_block', 'NAME');
          });
        });
      });

      suite('Next', function() {
        setup(function() {
          this.createNextWithChild = function() {
            const block = this.workspace.newBlock('stack_block');
            const childBlock = this.workspace.newBlock('stack_block');
            block.nextConnection.connect(childBlock.previousConnection);
            return block;
          };

          this.createNextWithShadow = function() {
            const block = this.workspace.newBlock('stack_block');
            block.nextConnection.setShadowDom(
                Blockly.Xml.textToDom(
                    '<block type="stack_block" id="test"></block>'));
            return block;
          };

          this.createNextWithShadowAndChild = function() {
            const block = this.workspace.newBlock('stack_block');
            const childBlock = this.workspace.newBlock('stack_block');
            block.nextConnection.connect(childBlock.previousConnection);
            block.nextConnection.setShadowDom(
                Blockly.Xml.textToDom(
                    '<block type="stack_block" id="test"></block>'));
            return block;
          };
        });

        suite('With serialization', function() {
          test('Child', function() {
            const block = this.createNextWithChild();
            const jso =
                Blockly.serialization.blocks.save(block);
            chai.assert.deepInclude(
                jso['next'], {'block': { 'type': 'stack_block', 'id': 'id2'}});
          });
  
          test.skip('Shadow', function() {
            const block = this.createNextWithShadow();
            const jso = Blockly.serialization.blocks.save(block);
            chai.assert.deepInclude(
                jso['next'], {'shadow': { 'type': 'stack_block', 'id': 'test'}});
          });
  
          test.skip('Overwritten shadow', function() {
            const block = this.createNextWithShadowAndChild();
            const jso = Blockly.serialization.blocks.save(block);
            chai.assert.deepInclude(
                jso['next'],
                {
                  'block': {
                    'type': 'stack_block',
                    'id': 'id2'
                  },
                  'shadow': {
                    'type': 'stack_block',
                    'id': 'test'
                  }
                });
          });

          test('Next block with inputs', function() {
            const block = this.workspace.newBlock('stack_block');
            const childBlock = this.workspace.newBlock('statement_block');
            const grandChildBlock = this.workspace.newBlock('stack_block');
            block.nextConnection.connect(childBlock.previousConnection);
            childBlock.getInput('NAME').connection
                .connect(grandChildBlock.previousConnection);
            const jso = Blockly.serialization.blocks.save(block);
            chai.assert.deepInclude(
                jso['next'],
                {
                  'block': {
                    'type': 'statement_block',
                    'id': 'id2',
                    'inputs': {
                      'NAME': {
                        'block': {
                          'type': 'stack_block',
                          'id': 'id4'
                        }
                      }
                    }
                  }
                }
            );
          });
        });

        suite('Without serialization', function() {
          test('Child', function() {
            const block = this.createNextWithChild();
            const jso = Blockly.serialization.blocks.save(
                block, {addNextBlocks: false});
            chai.assert.isUndefined(jso['next']);
          });
  
          test('Shadow', function() {
            const block = this.createNextWithShadow();
            const jso = Blockly.serialization.blocks.save(
                block, {addNextBlocks: false});
            chai.assert.isUndefined(jso['next']);
          });

          test('Overwritten shadow', function() {
            const block = this.createNextWithShadowAndChild();
            const jso = Blockly.serialization.blocks.save(
                block, {addNextBlocks: false});
            chai.assert.isUndefined(jso['next']);
          });
        });
      });
    });
  });

  suite('Variables', function() {
    test('Without type', function() {
      const variable = this.workspace.createVariable('testVar', '', 'testId');
      const jso = Blockly.serialization.variables.save(variable);
      assertProperty(jso, 'name', 'testVar');
      assertProperty(jso, 'id', 'testId');
      assertNoProperty(jso, 'type');
    });

    test('With type', function() {
      const variable = this.workspace
          .createVariable('testVar', 'testType', 'testId');
      const jso = Blockly.serialization.variables.save(variable);
      assertProperty(jso, 'name', 'testVar');
      assertProperty(jso, 'id', 'testId');
      assertProperty(jso, 'type', 'testType');
    });
  });
});