Add template title and description on 'get_block_template' hook

[Aljullu]

Changes proposed in this Pull Request:

Closes #42221.

This PR adds the template title and description in the get_block_template hook, which fixes #42221. I also added some tests to verify there are no regressions in the future and took the opportunity to simplify how we attach the template title and description in add_block_templates().

How to test the changes in this Pull Request:

Verify there are no regressions:

Move around the Site Editor freely, keeping an eye on WooCommerce templates titles and descriptions, making sure they always appear correctly.

Verify #42221 is fixed:

1. Enable a theme with custom WooCommerce template, like Tsubaki.
2. Go to Appearance > Editor > Templates and edit a WooCommerce template (ie: Single Product). Note: make sure you didn't have any previous edits on that template. This fix doesn't work for templates that had been modified in the past.
3. Make some edits in the template, save, and verify the title of the template doesn't change. (Before the fix, it would change from Single Product to single-product).

Enregistrament.de.pantalla.del.2024-02-01.11-10-29.webm

Changelog entry

• Automatically create a changelog entry from the details below.

Significance

• Patch
• Minor
• Major

Type

• Fix - Fixes an existing bug
• Add - Adds functionality
• Update - Update existing functionality
• Dev - Development related task
• Tweak - A minor adjustment to the codebase
• Performance - Address performance issues
• Enhancement - Improvement to existing functionality

Message

Fix the Site Editor showing the template slug instead of the template title when saving a WooCommerce block template customized by the theme.

Comment

[github-actions]

Hi @gigitux,

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

[github-actions]

Test Results Summary

Commit SHA: ef5d508

Test 🧪	Passed ✅	Failed 🚨	Broken 🚧	Skipped ⏭️	Unknown ❔	Total 📊	Duration ⏱️
API Tests	259	0	0	2	0	261	0m 37s
E2E Tests	291	0	0	18	0	309	7m 38s

---

To view the full API test report, click here.
To view the full E2E test report, click here.
To view all test reports, visit the WooCommerce Test Reports Dashboard.

[gigitux]

The fix LGTM, and I'm pre-approving this PR.

The only doubt that I have is that the current E2E test runs on TT4. So, even without your fix, the test doesn't fail.

Should we add a theme that overrides the Woo template to cover all the potential cases?

[Aljullu]

Thanks for the review, @gigitux!

The only doubt that I have is that the current E2E test runs on TT4. So, even without your fix, the test doesn't fail.

Heads-up that we have a specific workflow named Playwright E2E tests - BlockThemeWithTemplates that runs with a special theme with WooCommerce templates. All files ending with .block_theme_with_templates.spec.ts are run as part of that workflow. So the test modified in this PR is run with that theme, not with TT4.

I tried it again, and commenting out L61 causes the tests to fail. You need to run the tests like this:

pnpm run test:e2e:block-theme-with-templates ./tests/e2e/tests/templates/template-customization.block_theme_with_templates.spec.ts

[gigitux]

Heads-up that we have a specific workflow named Playwright E2E tests - BlockThemeWithTemplates that runs with a special theme with WooCommerce templates. All files ending with .block_theme_with_templates.spec.ts are run as part of that workflow. So the test modified in this PR is run with that theme, not with TT4.

TIL! Cool! At the same time, should we run the tests with both use cases?

• a theme that overrides the WooCommerce templates (like theme-with-woo-templates)
• a theme that doesn't override the WooCommerce templates (like TT4)

This discussion is unrelated to this PR, so feel free to merge it! Great work! 🚀

[Aljullu]

TIL! Cool! At the same time, should we run the tests with both use cases?

Good question. We do have tests for a block theme that doesn't override WooCommerce templates here. I was on the fence on whether I should add the check I added in this PR to verify template title is shown correctly to these other tests.

In fact, I initially did but undid it before committing. 😄 The reason I leaned towards not adding it was that it has never been a bug in block themes without custom templates, so it felt that it was an unnecessary assertion that would pollute the test. But honestly, I still don't have a strong opinion on this, so happy to add it if you think otherwise.

[gigitux]

The main thing is that with E2E tests, we should cover all the possible cases to have good coverage.

I don't know if it is possible, but when it makes sense (like in this case), we should run the same test on both configurations because we expect the behavior to be the same.

[Aljullu]

Makes sense. In ef5d508 I added the same check to the test that modifies the templates in block themes without custom templates.