Skip to content

Commit 5462b21

Browse files
BeksOmegaBeksOmega
authored
fix: comment have XML save and load new workspace comments classes (#7931)
* fix: have XML save and load new comment classes * chore: fix imports to resolve circular dependencies * chore: add round-trip tests * chore: skip failing test * fixup: PR comments
1 parent 407ff44 commit 5462b21

File tree

4 files changed

+237
-24
lines changed

4 files changed

+237
-24
lines changed

‎core/comments/comment_view.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ import * as dom from '../utils/dom.js';
1010
import {Svg} from '../utils/svg.js';
1111
import * as layers from '../layers.js';
1212
import * as css from '../css.js';
13-
import {Coordinate, Size, browserEvents} from '../utils.js';
13+
import {Coordinate} from '../utils/coordinate.js';
14+
import {Size} from '../utils/size.js';
15+
import * as browserEvents from '../browser_events.js';
1416
import * as touch from '../touch.js';
1517

1618
export class CommentView implements IRenderedElement {

‎core/xml.ts‎

Lines changed: 63 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,42 +19,63 @@ import * as utilsXml from './utils/xml.js';
1919
import type {VariableModel} from './variable_model.js';
2020
import * as Variables from './variables.js';
2121
import type {Workspace} from './workspace.js';
22-
import {WorkspaceComment} from './workspace_comment.js';
23-
import {WorkspaceCommentSvg} from './workspace_comment_svg.js';
24-
import type {WorkspaceSvg} from './workspace_svg.js';
22+
import {WorkspaceSvg} from './workspace_svg.js';
2523
import * as renderManagement from './render_management.js';
24+
import {WorkspaceComment} from './comments/workspace_comment.js';
25+
import {RenderedWorkspaceComment} from './comments/rendered_workspace_comment.js';
26+
import {Coordinate} from './utils/coordinate.js';
2627

2728
/**
2829
* Encode a block tree as XML.
2930
*
3031
* @param workspace The workspace containing blocks.
31-
* @param opt_noId True if the encoder should skip the block IDs.
32+
* @param skipId True if the encoder should skip the block IDs. False by
33+
* default.
3234
* @returns XML DOM element.
3335
*/
34-
export function workspaceToDom(
35-
workspace: Workspace,
36-
opt_noId?: boolean,
37-
): Element {
36+
export function workspaceToDom(workspace: Workspace, skipId = false): Element {
3837
const treeXml = utilsXml.createElement('xml');
3938
const variablesElement = variablesToDom(
4039
Variables.allUsedVarModels(workspace),
4140
);
4241
if (variablesElement.hasChildNodes()) {
4342
treeXml.appendChild(variablesElement);
4443
}
45-
const comments = workspace.getTopComments(true);
46-
for (let i = 0; i < comments.length; i++) {
47-
const comment = comments[i];
48-
treeXml.appendChild(comment.toXmlWithXY(opt_noId));
44+
for (const comment of workspace.getTopComments()) {
45+
treeXml.appendChild(
46+
saveWorkspaceComment(comment as AnyDuringMigration, skipId),
47+
);
4948
}
5049
const blocks = workspace.getTopBlocks(true);
5150
for (let i = 0; i < blocks.length; i++) {
5251
const block = blocks[i];
53-
treeXml.appendChild(blockToDomWithXY(block, opt_noId));
52+
treeXml.appendChild(blockToDomWithXY(block, skipId));
5453
}
5554
return treeXml;
5655
}
5756

57+
/** Serializes the given workspace comment to XML. */
58+
function saveWorkspaceComment(
59+
comment: WorkspaceComment,
60+
skipId = false,
61+
): Element {
62+
const elem = utilsXml.createElement('comment');
63+
if (!skipId) elem.setAttribute('id', comment.id);
64+
65+
elem.setAttribute('x', `${comment.getRelativeToSurfaceXY().x}`);
66+
elem.setAttribute('y', `${comment.getRelativeToSurfaceXY().y}`);
67+
elem.setAttribute('w', `${comment.getSize().width}`);
68+
elem.setAttribute('h', `${comment.getSize().height}`);
69+
70+
if (comment.getText()) elem.textContent = comment.getText();
71+
if (comment.isCollapsed()) elem.setAttribute('collapsed', 'true');
72+
if (!comment.isOwnEditable()) elem.setAttribute('editable', 'false');
73+
if (!comment.isOwnMovable()) elem.setAttribute('movable', 'false');
74+
if (!comment.isOwnDeletable()) elem.setAttribute('deletable', 'false');
75+
76+
return elem;
77+
}
78+
5879
/**
5980
* Encode a list of variables as XML.
6081
*
@@ -443,15 +464,7 @@ export function domToWorkspace(xml: Element, workspace: Workspace): string[] {
443464
} else if (name === 'shadow') {
444465
throw TypeError('Shadow block cannot be a top-level block.');
445466
} else if (name === 'comment') {
446-
if (workspace.rendered) {
447-
WorkspaceCommentSvg.fromXmlRendered(
448-
xmlChildElement,
449-
workspace as WorkspaceSvg,
450-
width,
451-
);
452-
} else {
453-
WorkspaceComment.fromXml(xmlChildElement, workspace);
454-
}
467+
loadWorkspaceComment(xmlChildElement, workspace);
455468
} else if (name === 'variables') {
456469
if (variablesFirst) {
457470
domToVariables(xmlChildElement, workspace);
@@ -478,6 +491,34 @@ export function domToWorkspace(xml: Element, workspace: Workspace): string[] {
478491
return newBlockIds;
479492
}
480493

494+
/** Deserializes the given comment state into the given workspace. */
495+
function loadWorkspaceComment(
496+
elem: Element,
497+
workspace: Workspace,
498+
): WorkspaceComment {
499+
const id = elem.getAttribute('id') ?? undefined;
500+
const comment = workspace.rendered
501+
? new RenderedWorkspaceComment(workspace as WorkspaceSvg, id)
502+
: new WorkspaceComment(workspace, id);
503+
504+
comment.setText(elem.textContent ?? '');
505+
506+
const x = parseInt(elem.getAttribute('x') ?? '', 10);
507+
const y = parseInt(elem.getAttribute('y') ?? '', 10);
508+
if (!isNaN(x) && !isNaN(y)) comment.moveTo(new Coordinate(x, y));
509+
510+
const w = parseInt(elem.getAttribute('w') ?? '', 10);
511+
const h = parseInt(elem.getAttribute('h') ?? '', 10);
512+
if (!isNaN(w) && !isNaN(h)) comment.setSize(new Size(w, h));
513+
514+
if (elem.getAttribute('collapsed') === 'true') comment.setCollapsed(true);
515+
if (elem.getAttribute('editable') === 'false') comment.setEditable(false);
516+
if (elem.getAttribute('movable') === 'false') comment.setMovable(false);
517+
if (elem.getAttribute('deletable') === 'false') comment.setDeletable(false);
518+
519+
return comment;
520+
}
521+
481522
/**
482523
* Decode an XML DOM and create blocks on the workspace. Position the new
483524
* blocks immediately below prior blocks, aligned by their starting edge.

‎tests/mocha/clipboard_test.js‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,8 @@ suite('Clipboard', function () {
114114
});
115115

116116
suite('pasting comments', function () {
117-
test('pasted comments are bumped to not overlap', function () {
117+
// TODO: Reenable test when we readd copy-paste.
118+
test.skip('pasted comments are bumped to not overlap', function () {
118119
Blockly.Xml.domToWorkspace(
119120
Blockly.utils.xml.textToDom(
120121
'<xml><comment id="test" x=10 y=10/></xml>',

‎tests/mocha/serializer_test.js‎

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1868,12 +1868,181 @@ Serializer.Mutations.testSuites = [
18681868
Serializer.Mutations.Procedure,
18691869
];
18701870

1871+
Serializer.Comments = new SerializerTestSuite('Comments');
1872+
1873+
Serializer.Comments.Coordinates = new SerializerTestSuite('Coordinates');
1874+
Serializer.Comments.Coordinates.Basic = new SerializerTestCase(
1875+
'Basic',
1876+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
1877+
'<comment id="id******************" x="42" y="42" w="42" h="42">' +
1878+
'</comment>' +
1879+
'</xml>',
1880+
);
1881+
Serializer.Comments.Coordinates.Negative = new SerializerTestCase(
1882+
'Negative',
1883+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
1884+
'<comment id="id******************" x="-42" y="-42" w="42" h="42">' +
1885+
'</comment>' +
1886+
'</xml>',
1887+
);
1888+
Serializer.Comments.Coordinates.Zero = new SerializerTestCase(
1889+
'Zero',
1890+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
1891+
'<comment id="id******************" x="0" y="0" w="42" h="42">' +
1892+
'</comment>' +
1893+
'</xml>',
1894+
);
1895+
Serializer.Comments.Coordinates.testCases = [
1896+
Serializer.Comments.Coordinates.Basic,
1897+
Serializer.Comments.Coordinates.Negative,
1898+
Serializer.Comments.Coordinates.Zero,
1899+
];
1900+
1901+
Serializer.Comments.Size = new SerializerTestSuite('Size');
1902+
Serializer.Comments.Size.Basic = new SerializerTestCase(
1903+
'Basic',
1904+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
1905+
'<comment id="id******************" x="42" y="42" w="42" h="42">' +
1906+
'</comment>' +
1907+
'</xml>',
1908+
);
1909+
Serializer.Comments.Size.testCases = [Serializer.Comments.Size.Basic];
1910+
1911+
Serializer.Comments.Text = new SerializerTestSuite('Text');
1912+
Serializer.Comments.Text.Symbols = new SerializerTestCase(
1913+
'Symbols',
1914+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
1915+
'<comment id="id******************" x="42" y="42" w="42" h="42">' +
1916+
'~`!@#$%^*()_+-={[}]|\\:;,.?/' +
1917+
'</comment>' +
1918+
'</xml>',
1919+
);
1920+
Serializer.Comments.Text.EscapedSymbols = new SerializerTestCase(
1921+
'EscapedSymbols',
1922+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
1923+
'<comment id="id******************" x="42" y="42" w="42" h="42">' +
1924+
'&amp;&lt;&gt;' +
1925+
'</comment>' +
1926+
'</xml>',
1927+
);
1928+
Serializer.Comments.Text.SingleQuotes = new SerializerTestCase(
1929+
'SingleQuotes',
1930+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
1931+
'<comment id="id******************" x="42" y="42" w="42" h="42">' +
1932+
"'test'" +
1933+
'</comment>' +
1934+
'</xml>',
1935+
);
1936+
Serializer.Comments.Text.DoubleQuotes = new SerializerTestCase(
1937+
'DoubleQuotes',
1938+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
1939+
'<comment id="id******************" x="42" y="42" w="42" h="42">' +
1940+
'"test"' +
1941+
'</comment>' +
1942+
'</xml>',
1943+
);
1944+
Serializer.Comments.Text.Numbers = new SerializerTestCase(
1945+
'Numbers',
1946+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
1947+
'<comment id="id******************" x="42" y="42" w="42" h="42">' +
1948+
'1234567890a123a123a' +
1949+
'</comment>' +
1950+
'</xml>',
1951+
);
1952+
Serializer.Comments.Text.Emoji = new SerializerTestCase(
1953+
'Emoji',
1954+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
1955+
'<comment id="id******************" x="42" y="42" w="42" h="42">' +
1956+
'😀👋🏿👋🏾👋🏽👋🏼👋🏻😀❤❤❤' +
1957+
'</comment>' +
1958+
'</xml>',
1959+
);
1960+
Serializer.Comments.Text.Russian = new SerializerTestCase(
1961+
'Russian',
1962+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
1963+
'<comment id="id******************" x="42" y="42" w="42" h="42">' +
1964+
'ты любопытный кот' +
1965+
'</comment>' +
1966+
'</xml>',
1967+
);
1968+
Serializer.Comments.Text.Japanese = new SerializerTestCase(
1969+
'Japanese',
1970+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
1971+
'<comment id="id******************" x="42" y="42" w="42" h="42">' +
1972+
'あなたは好奇心旺盛な猫です' +
1973+
'</comment>' +
1974+
'</xml>',
1975+
);
1976+
Serializer.Comments.Text.Zalgo = new SerializerTestCase(
1977+
'Zalgo',
1978+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
1979+
'<comment id="id******************" x="42" y="42" w="42" h="42">' +
1980+
'z̴̪͈̲̜͕̽̈̀͒͂̓̋̉̍a̸̧̧̜̻̘̤̫̱̲͎̞̻͆̋ļ̸̛̖̜̳͚̖͔̟̈́͂̉̀͑̑͑̎ǵ̸̫̳̽̐̃̑̚̕o̶͇̫͔̮̼̭͕̹̘̬͋̀͆̂̇̋͊̒̽' +
1981+
'</comment>' +
1982+
'</xml>',
1983+
);
1984+
Serializer.Comments.Text.testCases = [
1985+
Serializer.Comments.Text.Symbols,
1986+
Serializer.Comments.Text.EscapedSymbols,
1987+
Serializer.Comments.Text.SingleQuotes,
1988+
Serializer.Comments.Text.DoubleQuotes,
1989+
Serializer.Comments.Text.Numbers,
1990+
Serializer.Comments.Text.Emoji,
1991+
Serializer.Comments.Text.Russian,
1992+
Serializer.Comments.Text.Japanese,
1993+
Serializer.Comments.Text.Zalgo,
1994+
];
1995+
1996+
Serializer.Comments.Attributes = new SerializerTestSuite('Attributes');
1997+
Serializer.Comments.Attributes.Collapsed = new SerializerTestCase(
1998+
'Collapsed',
1999+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
2000+
'<comment id="id******************" x="42" y="42" w="42" h="42" collapsed="true">' +
2001+
'</comment>' +
2002+
'</xml>',
2003+
);
2004+
Serializer.Comments.Attributes.NotEditable = new SerializerTestCase(
2005+
'NotEditable',
2006+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
2007+
'<comment id="id******************" x="42" y="42" w="42" h="42" editable="false">' +
2008+
'</comment>' +
2009+
'</xml>',
2010+
);
2011+
Serializer.Comments.Attributes.NotMovable = new SerializerTestCase(
2012+
'NotMovable',
2013+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
2014+
'<comment id="id******************" x="42" y="42" w="42" h="42" movable="false">' +
2015+
'</comment>' +
2016+
'</xml>',
2017+
);
2018+
Serializer.Comments.Attributes.NotDeletable = new SerializerTestCase(
2019+
'NotDeletable',
2020+
'<xml xmlns="https://developers.google.com/blockly/xml">' +
2021+
'<comment id="id******************" x="42" y="42" w="42" h="42" deletable="false">' +
2022+
'</comment>' +
2023+
'</xml>',
2024+
);
2025+
Serializer.Comments.Attributes.testCases = [
2026+
Serializer.Comments.Attributes.Collapsed,
2027+
Serializer.Comments.Attributes.NotEditable,
2028+
Serializer.Comments.Attributes.NotMovable,
2029+
Serializer.Comments.Attributes.NotDeletable,
2030+
];
2031+
2032+
Serializer.Comments.testSuites = [
2033+
Serializer.Comments.Coordinates,
2034+
Serializer.Comments.Size,
2035+
Serializer.Comments.Text,
2036+
Serializer.Comments.Attributes,
2037+
];
2038+
18712039
Serializer.testSuites = [
18722040
Serializer.Attributes,
18732041
Serializer.Fields,
18742042
Serializer.Icons,
18752043
Serializer.Connections,
18762044
Serializer.Mutations,
2045+
Serializer.Comments,
18772046
];
18782047

18792048
const runSerializerTestSuite = (serializer, deserializer, testSuite) => {

0 commit comments

Comments
 (0)