adds default alt values for #1520 #10482

antpb · 2018-10-10T17:06:31Z

Description

Sets default alt values to fix #1520 I am open to discussion around what the default value should be. I liked @afercia 's suggestion in the issue

How to test:

create image block
add image with no alt value
inspect image to see that alt value is now set as a readable string "This image has an empty alt attribute, the file name is FILENAME"

Soean · 2018-10-10T17:10:43Z

packages/block-library/src/image/edit.js


 	if ( typeof caption !== 'object' ) {
 		caption = create( { html: caption } );
 	}

+	if ( ! alt ) {
+		alt = 'This image has an empty alt attribute, the file name is ' + filename;


This message should be translatable

NICE catch. Thank you.

tofumatt

This approach works for me but as mentioned: the field should be translatable and it'd be great to add an E2E test for this (I guess in a11y tests or in a new image block test file).

tofumatt

This needs to use sprintf() for the translation to work.

Are you comfortable writing E2E tests for this as well? 😄

tofumatt · 2018-10-10T18:08:41Z

packages/block-library/src/image/edit.js


 	if ( typeof caption !== 'object' ) {
 		caption = create( { html: caption } );
 	}

+	if ( ! alt ) {
+		alt = __( 'This image has an empty alt attribute, the file name is ' ) + filename;


This needs to use sprintf() (example usage: https://github.com/WordPress/gutenberg/blob/master/packages/block-library/src/heading/heading-toolbar.js#L18)

Also, a bit pedantic but I think the comma should be a semi-colon, so it should be:

alt = sprintf( __( 'This image has an empty alt attribute; its file name is "%s"' ), filename );

Cool. Changing. Does caption also need this?

Nope, caption is not content that we provide text for; it doesn't needs to be localised.

I have not worked on E2E test before, but that is no reason to avoid doing so now. If you have any resources I'd be super appreciative for them. I'll continue working through it today.

tofumatt · 2018-10-10T18:26:51Z

Sadly I’m not sure we have many references beyond the tests themselves and Google’s Puppeteer API docs. The docs are quite handy and the tests themselves are pretty readable because of Puppeteer’s quite friendly API. I’d recommended checking `test/e2e/specs/` for some tests to get a sense of how they work; you can always check in Slack’s #core-editor channel too for help :-)

antpb · 2018-10-10T19:55:59Z

I'm comfortable learning how to write the tests. I spent a bit of time reviewing the docs/source code of other tests. I think I can get this going. :)

antpb · 2018-10-11T02:36:26Z

Worth noting here, in my learning to build tests, I found adding-inline-tokens.test.js did essentially what we would want to do to test this PR. I'll also need to go through other tests to make sure there are no other image adding tests that will not have the proper alt default.

This line is where the alt value should not have passed: https://github.com/WordPress/gutenberg/blob/master/test/e2e/specs/adding-inline-tokens.test.js#L47

~~This presented a different issue. We need to set default image alt on inline-image block as well. Going to do some digging into what needs to change there.~~

Alrighty! Latest PR fixes inline-image as well as image block. I'm still working on making the regular image tests. I've updated the inline tests to include the new default string.

tofumatt · 2018-10-12T12:19:05Z

Nice! I'll have a look sometimes today, thanks for that! 👍

antpb · 2018-10-12T15:43:50Z

~~Another thing to note that I am trying to figure out currently: Travis is not happy in comparing the raw post data because of the quotes encoding. I need to look into where that is being returned.~~

Expected: file name is "
Got: file name is &quot

    expect(received).toMatch(expected)
    Expected value to match:
      /<!-- wp:paragraph -->\s*<p>a\u00A0<img class="wp-image-\d+" style="width:\s*10px;?" src="[^"]+\/6c0dcb7f-627c-418b-97f8-7b563cf99b24\.png" alt="This image has an empty alt attribute; its file name is "10x10_e2e_test_image_z9T8jK.png""\/?><\/p>\s*<!-- \/wp:paragraph -->/
    Received:
      "<!-- wp:paragraph -->
    <p>a <img class=\"wp-image-153\" style=\"width: 10px;\" src=\"http://localhost:8889/wp-content/uploads/2018/10/6c0dcb7f-627c-418b-97f8-7b563cf99b24.png\" alt=\"This image has an empty alt attribute; its file name is &quot;6c0dcb7f-627c-418b-97f8-7b563cf99b24.png&quot;\"></p>
    <!-- /wp:paragraph -->"
      46 | 		// Check the content.
      47 | 		const regex = new RegExp( `<!-- wp:paragraph -->\\s*<p>a\\u00A0<img class="wp-image-\\d+" style="width:\\s*10px;?" src="[^"]+\\/${ filename }\\.png" alt="This image has an empty alt attribute; its file name is "10x10_e2e_test_image_z9T8jK.png""\\/?><\\/p>\\s*<!-- \\/wp:paragraph -->` );
    > 48 | 		expect( await getEditedPostContent() ).toMatch( regex );
         | 		                                       ^
      49 | 	} );
      50 | } );
      51 |

Escaping in that string didnt seem to fix it (as you can see in the travis report.)

afercia · 2018-10-21T16:09:11Z

Worth noting also the featured image would need the same information. The featured image preview uses a button with an aria-label, see also #10869

ocean90 · 2018-10-21T17:27:36Z

packages/editor/src/components/rich-text/core-tokens/image/index.js

-	save( { id, url, alt, width } ) {
+	save( { id, url, alt, width, filename } ) {
+		if ( ! alt ) {
+			alt = sprintf( __( 'This image has an empty alt attribute; its file name is \"%s\"' ), filename );


No need for the escaping.

ocean90 · 2018-10-21T17:27:48Z

packages/block-library/src/image/edit.js


 	if ( typeof caption !== 'object' ) {
 		caption = create( { html: caption } );
 	}

+	if ( ! alt ) {
+		alt = sprintf( __( 'This image has an empty alt attribute; its file name is \"%s\"' ), filename );


No need for the escaping.

ocean90 · 2018-10-21T17:28:59Z

test/e2e/specs/adding-inline-tokens.test.js

@@ -44,7 +44,7 @@ describe( 'adding inline tokens', () => {
 		await page.click( '.media-modal button.media-button-select' );

 		// Check the content.
-		const regex = new RegExp( `<!-- wp:paragraph -->\\s*<p>a\\u00A0<img class="wp-image-\\d+" style="width:\\s*10px;?" src="[^"]+\\/${ filename }\\.png" alt=""\\/?><\\/p>\\s*<!-- \\/wp:paragraph -->` );
+		const regex = new RegExp( `<!-- wp:paragraph -->\\s*<p>a\\u00A0<img class="wp-image-\\d+" style="width:\\s*10px;?" src="[^"]+\\/${ filename }\\.png" alt="This image has an empty alt attribute; its file name is "10x10_e2e_test_image_z9T8jK.png""\\/?><\\/p>\\s*<!-- \\/wp:paragraph -->` );


You have to use the HTML entity " for the quotes to check for valid HTML.

antpb · 2018-10-23T16:56:41Z

Closing this as I have rebased and made all of the above code change recommendations at his PR: #10960. As for @afercia 's recent comment about featured image, I need to look into that. Might make a new issue so we can get these default alt values added asap. I have a PR already open that is manipulating featured image behavior. I'll see if I can just wrap the default alt values into there.

adds default alt values to better factor in assitive readers

838bb12

antpb requested a review from tofumatt October 10, 2018 17:06

Soean reviewed Oct 10, 2018

View reviewed changes

tofumatt requested changes Oct 10, 2018

View reviewed changes

adds translations

b6100fe

tofumatt requested changes Oct 10, 2018

View reviewed changes

fixes translation

eaa6c02

chrisvanpatten added [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Feature] Media Anything that impacts the experience of managing media labels Oct 10, 2018

antpb added 2 commits October 10, 2018 21:41

fixes adding-inline-tokens.test.js to include default alt value

7dd34de

fixes inline-image block default alt attribute

fd82d71

tofumatt self-requested a review October 12, 2018 12:18

whoops, gotta escape - Should make Travis happy. :)

708914f

afercia mentioned this pull request Oct 21, 2018

Add aria-label to describe action of featured image update button #10869

Merged

ocean90 requested changes Oct 21, 2018

View reviewed changes

antpb closed this Oct 23, 2018

This was referenced Oct 23, 2018

adds default alt values to inline images and the image block #10960

Closed

adds default alt values in editing context #11218

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adds default alt values for #1520 #10482

adds default alt values for #1520 #10482

antpb commented Oct 10, 2018

Soean Oct 10, 2018

antpb Oct 10, 2018

tofumatt left a comment

tofumatt left a comment

tofumatt Oct 10, 2018

tofumatt Oct 10, 2018

antpb Oct 10, 2018

tofumatt Oct 10, 2018

antpb Oct 10, 2018 •

edited

Loading

tofumatt commented Oct 10, 2018 via email

antpb commented Oct 10, 2018 •

edited

Loading

antpb commented Oct 11, 2018 •

edited

Loading

tofumatt commented Oct 12, 2018

antpb commented Oct 12, 2018 •

edited

Loading

afercia commented Oct 21, 2018

ocean90 Oct 21, 2018

ocean90 Oct 21, 2018

ocean90 Oct 21, 2018

antpb commented Oct 23, 2018

adds default alt values for #1520 #10482

adds default alt values for #1520 #10482

Conversation

antpb commented Oct 10, 2018

Description

How to test:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tofumatt left a comment

Choose a reason for hiding this comment

tofumatt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

antpb Oct 10, 2018 • edited Loading

Choose a reason for hiding this comment

tofumatt commented Oct 10, 2018 via email

antpb commented Oct 10, 2018 • edited Loading

antpb commented Oct 11, 2018 • edited Loading

tofumatt commented Oct 12, 2018

antpb commented Oct 12, 2018 • edited Loading

afercia commented Oct 21, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

antpb commented Oct 23, 2018

antpb Oct 10, 2018 •

edited

Loading

antpb commented Oct 10, 2018 •

edited

Loading

antpb commented Oct 11, 2018 •

edited

Loading

antpb commented Oct 12, 2018 •

edited

Loading