From 343723d51afb07d54d74807404686624ec6bcf83 Mon Sep 17 00:00:00 2001 From: Anton Timmermans Date: Fri, 25 Jan 2019 11:36:36 +0100 Subject: [PATCH 1/4] Rename variable to make code more clear --- packages/blocks/src/api/validation.js | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/packages/blocks/src/api/validation.js b/packages/blocks/src/api/validation.js index 452c8f832a43f..5c49854f90fcd 100644 --- a/packages/blocks/src/api/validation.js +++ b/packages/blocks/src/api/validation.js @@ -620,30 +620,30 @@ export function isEquivalentHTML( actual, expected ) { * * Logs to console in development environments when invalid. * - * @param {string|Object} blockTypeOrName Block type. - * @param {Object} attributes Parsed block attributes. - * @param {string} innerHTML Original block content. + * @param {string|Object} blockTypeOrName Block type. + * @param {Object} attributes Parsed block attributes. + * @param {string} expectedBlockContent Original block content. * * @return {boolean} Whether block is valid. */ -export function isValidBlockContent( blockTypeOrName, attributes, innerHTML ) { +export function isValidBlockContent( blockTypeOrName, attributes, expectedBlockContent ) { const blockType = normalizeBlockType( blockTypeOrName ); - let saveContent; + let actualBlockContent; try { - saveContent = getSaveContent( blockType, attributes ); + actualBlockContent = getSaveContent( blockType, attributes ); } catch ( error ) { log.error( 'Block validation failed because an error occurred while generating block content:\n\n%s', error.toString() ); return false; } - const isValid = isEquivalentHTML( innerHTML, saveContent ); + const isValid = isEquivalentHTML( expectedBlockContent, actualBlockContent ); if ( ! isValid ) { log.error( 'Block validation failed for `%s` (%o).\n\nExpected:\n\n%s\n\nActual:\n\n%s', blockType.name, blockType, - saveContent, - innerHTML + actualBlockContent, + expectedBlockContent ); } From 16a32f45e51996c80ec47cd793c122f8d7989186 Mon Sep 17 00:00:00 2001 From: Anton Timmermans Date: Fri, 25 Jan 2019 11:37:06 +0100 Subject: [PATCH 2/4] Fix display of expected and actual block HTML The variable were in the wrong order, making the message confusing. It would show the actual HTML as the expected HTML and visa versa. --- packages/blocks/src/api/validation.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/blocks/src/api/validation.js b/packages/blocks/src/api/validation.js index 5c49854f90fcd..4cb616ac7b4f4 100644 --- a/packages/blocks/src/api/validation.js +++ b/packages/blocks/src/api/validation.js @@ -642,8 +642,8 @@ export function isValidBlockContent( blockTypeOrName, attributes, expectedBlockC 'Block validation failed for `%s` (%o).\n\nExpected:\n\n%s\n\nActual:\n\n%s', blockType.name, blockType, - actualBlockContent, - expectedBlockContent + expectedBlockContent, + actualBlockContent ); } From 37792c46fb90f02864389f009dcd338c6272e56d Mon Sep 17 00:00:00 2001 From: Anton Timmermans Date: Mon, 11 Mar 2019 18:09:04 +0100 Subject: [PATCH 3/4] Change wording to be more clear Expected & Actual were confusing words to use in this content. This change makes the message actually reflect what the values are. --- packages/blocks/src/api/validation.js | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/blocks/src/api/validation.js b/packages/blocks/src/api/validation.js index 4cb616ac7b4f4..335f5c3b8bd39 100644 --- a/packages/blocks/src/api/validation.js +++ b/packages/blocks/src/api/validation.js @@ -622,28 +622,28 @@ export function isEquivalentHTML( actual, expected ) { * * @param {string|Object} blockTypeOrName Block type. * @param {Object} attributes Parsed block attributes. - * @param {string} expectedBlockContent Original block content. + * @param {string} originalBlockContent Original block content. * * @return {boolean} Whether block is valid. */ -export function isValidBlockContent( blockTypeOrName, attributes, expectedBlockContent ) { +export function isValidBlockContent( blockTypeOrName, attributes, originalBlockContent ) { const blockType = normalizeBlockType( blockTypeOrName ); - let actualBlockContent; + let generatedBlockContent; try { - actualBlockContent = getSaveContent( blockType, attributes ); + generatedBlockContent = getSaveContent( blockType, attributes ); } catch ( error ) { log.error( 'Block validation failed because an error occurred while generating block content:\n\n%s', error.toString() ); return false; } - const isValid = isEquivalentHTML( expectedBlockContent, actualBlockContent ); + const isValid = isEquivalentHTML( originalBlockContent, generatedBlockContent ); if ( ! isValid ) { log.error( - 'Block validation failed for `%s` (%o).\n\nExpected:\n\n%s\n\nActual:\n\n%s', + 'Block validation failed for `%s` (%o).\n\nContent generated by `save` function:\n\n%s\n\nContent retrieved from post body:\n\n%s', blockType.name, blockType, - expectedBlockContent, - actualBlockContent + generatedBlockContent, + originalBlockContent ); } From 62a9354f38629163f701ed0eb4179d65049e3111 Mon Sep 17 00:00:00 2001 From: Anton Timmermans Date: Mon, 11 Mar 2019 21:41:35 +0100 Subject: [PATCH 4/4] Regenerate docs --- packages/blocks/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/blocks/README.md b/packages/blocks/README.md index e2074fa23bacc..960edae9da773 100644 --- a/packages/blocks/README.md +++ b/packages/blocks/README.md @@ -574,7 +574,7 @@ Logs to console in development environments when invalid. - **blockTypeOrName** `(string|Object)`: Block type. - **attributes** `Object`: Parsed block attributes. -- **innerHTML** `string`: Original block content. +- **originalBlockContent** `string`: Original block content. **Returns**