Adds transcript block and meta #221

nateconley · 2023-02-10T22:21:14Z

Description of the Change

Adds a block that saves the transcript to post meta and allows editor to either link to the transcript, display the transcript, or only have the transcript accessible via the endpoint.

Closes #28

TODO:

Add the endpoint for the transcript as a barebones HTML file
Add the endpoint to the podcast RSS feed per item: <podcast:transcript url="https://example.com/podcasts/podcast-name/episode-slug/transcript.html" type="text/html" language="en" />
Add endpoint to block link
Add tests

Alternate Designs

This approach is as a block, also discussed were this functionality a meta field.

Possible Drawbacks

This approach does not account for the classic editor.

Verification Process

Add a transcript from the podcast block sidebar

Checklist:

I have read the CONTRIBUTING document.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my change.
All new and existing tests passed.

Changelog Entry

Added - Podcast transcripts

Credits

@nateconley

nateconley · 2023-04-28T05:21:36Z

Hi @peterwilsoncc ! This is now ready for review. There is much more discussion on the approach to this in the original issue thread: #28

I added two unit tests, but my functions do not have full coverage. I'm happy to add more if given a bit of direction. I did not add any new E2E tests. Again, happy to add those in if you can tell me what coverage you'd like to see.

When building the new transcript block, I tried to write the block using a more updated approach to block-building without changing the original block methodology (except when I did make an addition to those files, the prettier config made some formatting edits).

One thing to note is that this update will require flushing rewrite rules. How do you usually like to approach that? Upgrade instructions? Upgrade routine?

peterwilsoncc

I've added a few notes inline.

I'm not sure it is possible to flush the rewrite rules automatically upon updating a plugin. According to the docs, the upgrader_process_complete hook runs using the old version of the plugin, not the new.

It's a little ugly but you might be able to use an option simple_podcasting_db_version and flush rewrite rules if it's not set or less than two. If this is the approach taken, I'd recommend limiting the check so it only happens within the dashboard. The rules don't need to be flushed prior to someone visiting the admin and creating/editing a new podcast.

Other people may have better suggestions though, maybe ask around a bit wider.

includes/blocks.php

peterwilsoncc · 2023-05-23T00:31:13Z

templates/transcript.php

+$podcast_slug = get_query_var( 'podcasting-episode' );
+$post_object  = get_page_by_path( $podcast_slug, OBJECT, 'post' );
+if ( $post_object instanceof WP_Post ) {
+	echo wp_kses_post(


You can run the transcript through kses on save rather than render, and then treat it as trusted data on output. This is what WP Core does for post content, etc as kses is a relatively expensive function to run.

@peterwilsoncc I've addressed this feedback in this commit: 9264fa4. Thanks

peterwilsoncc · 2023-05-23T00:33:11Z

templates/transcript.php

@@ -0,0 +1,31 @@
+<?php


I think it would be better to use the post.php template for the transcript when displaying it via a link. I don't really understand the comment Intentionally barebones with the minimum html for use by tools, why have you done that?

@peterwilsoncc The intention here was to follow a spec defined by Podcastindex.org. Intentionally barebones because there may be players that are able to read the HTML. Using the post.php template makes sense for humans reading this, should there be two versions? Original comment here: #28 (comment)

The intention here was to follow a spec defined by Podcastindex.org

@nateconley Understood and makes sense.

Do you think it's worth noindexing the transcript page so it doesn't end up in search engines? To allow developers to filter the results for their site, the code could be:

if ( function_exists( 'wp_robots' ) && function_exists( 'wp_robots_no_robots' ) && function_exists( 'add_filter' ) ) { add_filter( 'wp_robots', 'wp_robots_no_robots' ); wp_robots(); }

Thanks for the great suggestion. This has been added.

includes/blocks/podcast-transcript/markup.php

includes/transcripts.php

peterwilsoncc · 2023-05-23T00:58:51Z

templates/transcript.php

+	<meta charset="UTF-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<meta name="viewport" content="width=device-width, initial-scale=1.0">
+	<title><?php esc_html_e( 'Transcript', 'simple-podcasting' ); ?> - <?php echo esc_html( get_the_title() ); ?></title>


This is better for internationalization.

I've removed the escaping for get_the_title() as it's escaped on save and considered safe.

Suggested change

<title><?php esc_html_e( 'Transcript', 'simple-podcasting' ); ?> - <?php echo esc_html( get_the_title() ); ?></title>

<title><?php

printf(

esc_html__( 'Transcript - %s', 'simple-podcasting' ),

get_the_title()

);

?></title>

@peterwilsoncc, Most of the data is sanitised/escaped on save, and this is a very small concern, but in case an attacker would get hold of DB or is able to modify values of wp_posts, I think an XSS attack would be easy to do here, and I don't see much of an issue with escaping here(unless we're facing double escaping issues). So I'm in favour of keeping the escape, but let me know what you think about it.

nateconley · 2023-06-09T17:26:14Z

@peterwilsoncc I left a comment on one of your concerns. I do not have time until at least two weeks from now to dig into this more.

peterwilsoncc

I've added a few notes following some branch testing.

The taxonomy name constant was renamed so I pushed c8216c25f70ef48c7b0971576a2758c550e98768 to resolve that.

peterwilsoncc · 2023-09-20T00:41:17Z

templates/transcript.php

@@ -0,0 +1,31 @@
+<?php


The intention here was to follow a spec defined by Podcastindex.org

@nateconley Understood and makes sense.

Do you think it's worth noindexing the transcript page so it doesn't end up in search engines? To allow developers to filter the results for their site, the code could be:

if ( function_exists( 'wp_robots' ) && function_exists( 'wp_robots_no_robots' ) && function_exists( 'add_filter' ) ) { add_filter( 'wp_robots', 'wp_robots_no_robots' ); wp_robots(); }

peterwilsoncc · 2023-09-20T00:46:17Z

templates/transcript.php

+		printf(
+			/* translators: %s: The page title */
+			esc_html__( 'Transcript - %s', 'simple-podcasting' ),
+			get_the_title() // phpcs:ignore WordPress.Security.EscapeOutput 


Suggested change

get_the_title() // phpcs:ignore WordPress.Security.EscapeOutput

wp_strip_all_tags( get_the_title() )

WP allows HTML in titles and browsers just render the tags as is, so this avoids tabs that look like this

peterwilsoncc · 2023-09-20T00:58:35Z

includes/blocks/podcast-transcript/formats.js

+
+registerFormatType('podcasting/transcript-time', {
+	title: __('Time', 'simple-podcasting'),
+	tagName: 'time',


As you are using kses to sanitize, you'll need to add the timeelement to the list of allowed tags using the wp_kses_allowed_html filter.

Added this filter.

peterwilsoncc · 2023-09-20T01:05:12Z

includes/transcripts.php

+	foreach ( $body_node->childNodes as $node ) {
+		// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+		if ( XML_TEXT_NODE === $node->nodeType ) {
+			$filtered_text .= '<p>' . $doc->saveHTML( $node ) . '</p>';


I'm seeing some strange markup here when using the citation button.

The markup is rendered as

<cite>Person 1</cite> : Welcome to Show <cite>Person 2</cite> : I'm P2 <cite>Person 1:</cite> and I'm P1. </body>

The markup is saved in post meta as:

<cite>Person 1</cite>: Welcome to Show <cite>Person 2</cite>: I'm P2 <cite>Person 1:</cite> and I'm P1.

I was trying to make RichText do too much. This should have been InnerBlocks, and has been changed. The added benefit is that this is much more user friendly now.

nateconley · 2023-11-13T05:20:27Z

Quick update: I will have all comments addressed here by EOW.

nateconley · 2023-11-19T11:29:35Z

@peterwilsoncc This is ready for a re-review.

nateconley · 2023-11-19T11:59:48Z

I could also use a bit of help with the failing e2e tests. It looks like those might be caused by a missing dependency.

peterwilsoncc · 2023-11-23T22:24:39Z

Sorry Nate, I'm still having problems while testing.

If I start a citation within a transcript block then the editor stays as a citataion after I press return

Reviewing some documentation, it looks like having them as blocks rather than inline is a good improvement.

nateconley · 2023-11-30T08:01:40Z

@peterwilsoncc Thanks for the catch! I have modified the cite and time inner blocks to behave similar to other core blocks; when you press return a paragraph block is created.

Again, looks like cypress test are failing, but this seems unrelated to this branch from what I can see.

peterwilsoncc

Thanks @nateconley, this looks good to me.

I pushed a fix for the failing E2E tests by downgrading mochawesome-json-to-md. For some reason version 1.x isn't working properly with our GitHub actions.

dkotter and others added 4 commits July 27, 2022 14:07

Merge branch 'develop' into trunk

56fc27f

Merge branch 'develop' into trunk

925080c

Merge branch 'develop' into trunk

4d053f0

Adds transcript block and meta

2512270

nateconley mentioned this pull request Feb 10, 2023

Add transcript support for Level A Accessibility #28

Closed

cadic assigned nateconley Feb 13, 2023

cadic added this to the 1.5.0 milestone Feb 13, 2023

cadic unassigned nateconley Feb 13, 2023

jeffpaul assigned nateconley Feb 28, 2023

Merge branch 'trunk' into feature/transcript

849d725

jeffpaul requested review from a team and peterwilsoncc and removed request for a team April 11, 2023 14:29

jeffpaul requested a review from a team April 25, 2023 18:28

nateconley added 8 commits April 27, 2023 15:36

Adds endpoint links

14794a0

Merge branch 'develop' into feature/transcript

a15b1ff

Adds line to documentation

b3e44f8

Formatting

34cea3e

More detailed param comments

b734d9b

Formatting

400591d

Adds unit test

1464d87

Fix pre-commit

7f57bdb

nateconley marked this pull request as ready for review April 28, 2023 05:21

jeffpaul removed the request for review from a team May 8, 2023 14:36

peterwilsoncc reviewed May 23, 2023

View reviewed changes

jeffpaul modified the milestones: 1.5.0, 1.6.0 Jun 28, 2023

sksaju and others added 2 commits September 14, 2023 21:16

fixed phpcs issue on feature/transcript

51279b8

Merge branch 'develop' into feature/transcript

a64d95a

jeffpaul requested a review from peterwilsoncc September 18, 2023 15:47

peterwilsoncc reviewed Sep 20, 2023

View reviewed changes

github-actions bot added 4 commits October 9, 2023 08:50

Merge branch 'develop' into feature/transcript

0552e6f

Merge branch 'develop' into feature/transcript

ed4bdd8

Merge branch 'develop' into feature/transcript

0433758

Merge branch 'develop' into feature/transcript

be60808

nateconley added 2 commits November 19, 2023 01:13

Adds upgrade rewrite flush

7017fd0

Use inner blocks for transcripts

a14feab

github-actions bot added the needs:code-review This requires code review. label Nov 19, 2023

nateconley added 3 commits November 19, 2023 01:48

Formatting changes

24b8707

Webpack formatting fix

1100cc4

Formatting changes

790799c

Merge branch 'develop' into feature/transcript

fba3bcf

sksaju and others added 5 commits November 27, 2023 20:42

added missing dependency mochawesome-json-to-md

474b11c

fix test_get_transcript_from_post unit test case

7377f6a

Inner blocks are one line only

1a31000

Moves transcript blocks to separate function

253885b

Formatting

757f0b9

Downgrade mochawesome-json-to-md.

0e92898

peterwilsoncc approved these changes Dec 3, 2023

View reviewed changes

jeffpaul merged commit e72657b into develop Dec 4, 2023
11 checks passed

jeffpaul deleted the feature/transcript branch December 4, 2023 14:29

dkotter mentioned this pull request Jan 11, 2024

Add screenshots for recent enhancements #264

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds transcript block and meta #221

Adds transcript block and meta #221

nateconley commented Feb 10, 2023 •

edited

nateconley commented Apr 28, 2023

peterwilsoncc left a comment

peterwilsoncc May 23, 2023

sksaju Sep 14, 2023

peterwilsoncc May 23, 2023

nateconley Jun 9, 2023

peterwilsoncc Sep 20, 2023

nateconley Nov 19, 2023

peterwilsoncc May 23, 2023

kirtangajjar Jul 14, 2023

nateconley commented Jun 9, 2023

peterwilsoncc left a comment

peterwilsoncc Sep 20, 2023

peterwilsoncc Sep 20, 2023

nateconley Nov 19, 2023

peterwilsoncc Sep 20, 2023

nateconley Nov 19, 2023

peterwilsoncc Sep 20, 2023

nateconley Nov 19, 2023

nateconley commented Nov 13, 2023

nateconley commented Nov 19, 2023

nateconley commented Nov 19, 2023

peterwilsoncc commented Nov 23, 2023

nateconley commented Nov 30, 2023

peterwilsoncc left a comment

	get_the_title() // phpcs:ignore WordPress.Security.EscapeOutput
	wp_strip_all_tags( get_the_title() )

Adds transcript block and meta #221

Adds transcript block and meta #221

Conversation

nateconley commented Feb 10, 2023 • edited

Description of the Change

Alternate Designs

Possible Drawbacks

Verification Process

Checklist:

Changelog Entry

Credits

nateconley commented Apr 28, 2023

peterwilsoncc 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

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

nateconley commented Jun 9, 2023

peterwilsoncc 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nateconley commented Nov 13, 2023

nateconley commented Nov 19, 2023

nateconley commented Nov 19, 2023

peterwilsoncc commented Nov 23, 2023

nateconley commented Nov 30, 2023

peterwilsoncc left a comment

Choose a reason for hiding this comment

nateconley commented Feb 10, 2023 •

edited