Merge remote changes (SEO fields, column intros/covers/tags) with Wagtail 8.0 upgrade

This commit is contained in:
2026-10-12 16:27:48 +08:00
9 changed files with 124 additions and 1 deletions
+3
View File
@@ -9,6 +9,7 @@ from wagtail.search import index
from apps.core.blocks import COMMON_BLOCKS
from apps.core.models import SEOablePage
from apps.core.serializers import SEOImageSerializer
class BlogIndexPage(SEOablePage):
@@ -77,6 +78,8 @@ class BlogPage(SEOablePage):
APIField("published_at"),
APIField("intro"),
APIField("body"),
APIField("cover_image", serializer=SEOImageSerializer()),
APIField("tags"),
]
parent_page_types = ["blog.BlogIndexPage"]
+55
View File
@@ -7,6 +7,35 @@ from apps.blog.models import BlogIndexPage, BlogPage
pytestmark = pytest.mark.django_db
@pytest.mark.parametrize("app_label,index_name,page_name,extra", [
("products", "ProductIndexPage", "ProductPage", {}),
("solutions", "SolutionIndexPage", "SolutionPage", {"industry": "Manufacturing"}),
("cases", "CaseStudyIndexPage", "CaseStudyPage", {"client_name": "Client", "published_at": timezone.now()}),
("blog", "BlogIndexPage", "BlogPage", {"published_at": timezone.now()}),
])
def test_column_api_exposes_intro_and_cover(client, home_page, app_label, index_name, page_name, extra):
from django.apps import apps
from wagtail.models import Site
from wagtail.images import get_image_model
from wagtail.images.tests.utils import get_test_image_file
site = Site.objects.get(is_default_site=True)
site.root_page = home_page
site.save()
column = apps.get_model(app_label, index_name)(title="Column", slug=app_label, intro="Column introduction")
home_page.add_child(instance=column)
response = client.get(f"/api/v2/pages/{column.pk}/?fields=intro")
assert response.status_code == 200
assert response.json()["intro"] == column.intro
image = get_image_model().objects.create(title="Cover", file=get_test_image_file())
detail = apps.get_model(app_label, page_name)(title="Detail", slug="detail", cover_image=image, **extra)
column.add_child(instance=detail)
response = client.get(f"/api/v2/pages/{detail.pk}/?fields=cover_image")
assert response.status_code == 200
assert response.json()["cover_image"]["title"] == "Cover"
assert response.json()["cover_image"]["url"].startswith("http://testserver/media/")
@pytest.fixture
def blog_index(home_page):
index = BlogIndexPage(title="博客", slug="blog", intro="技术与行业洞察")
@@ -41,6 +70,32 @@ def test_blog_page_supports_tags(blog_index):
assert {t.name for t in post.tags.all()} == {"Django", "Wagtail"}
def test_blog_api_exposes_cover_and_tags(client, blog_index, home_page):
from wagtail.models import Site
from wagtail.images import get_image_model
from wagtail.images.tests.utils import get_test_image_file
site = Site.objects.get(is_default_site=True)
site.root_page = home_page
site.save()
image = get_image_model().objects.create(title="Blog cover", file=get_test_image_file())
post = BlogPage(title="Article", slug="article", published_at=timezone.now(), cover_image=image)
blog_index.add_child(instance=post)
post.tags.add("Django", "Wagtail")
post.save()
response = client.get(f"/api/v2/pages/{post.pk}/?fields=cover_image,tags")
assert response.status_code == 200
assert response.json()["cover_image"]["url"].startswith("http://testserver/media/")
assert set(response.json()["tags"]) == {"Django", "Wagtail"}
post.cover_image = None
post.save()
post.tags.clear()
post.save()
response = client.get(f"/api/v2/pages/{post.pk}/?fields=cover_image,tags")
assert response.json()["cover_image"] is None
assert response.json()["tags"] == []
def test_blog_index_context_orders_by_published_at_desc(blog_index):
older = BlogPage(
title="较早的文章",
+3
View File
@@ -7,6 +7,7 @@ from wagtail.search import index
from apps.core.blocks import COMMON_BLOCKS
from apps.core.models import SEOablePage
from apps.core.serializers import SEOImageSerializer
class CaseStudyIndexPage(SEOablePage):
@@ -19,6 +20,7 @@ class CaseStudyIndexPage(SEOablePage):
]
subpage_types = ["cases.CaseStudyPage"]
api_fields = SEOablePage.api_fields + [APIField("intro")]
parent_page_types = ["home.HomePage"]
class Meta:
@@ -70,6 +72,7 @@ class CaseStudyPage(SEOablePage):
APIField("published_at"),
APIField("summary"),
APIField("body"),
APIField("cover_image", serializer=SEOImageSerializer()),
]
parent_page_types = ["cases.CaseStudyIndexPage"]
+4
View File
@@ -16,6 +16,7 @@ from wagtail.fields import RichTextField, StreamField
from wagtail.models import Orderable, Page
from wagtail.snippets.models import register_snippet
from wagtail_headless_preview.models import HeadlessPreviewMixin
from apps.core.serializers import SEOImageSerializer
from apps.core.blocks import COMMON_BLOCKS
@@ -53,6 +54,9 @@ class SEOablePage(HeadlessPreviewMixin, Page):
api_fields = [
APIField("seo_title_override"),
APIField("seo_description_override"),
APIField("og_image", serializer=SEOImageSerializer()),
APIField("canonical_url"),
APIField("schema_json"),
]
class Meta:
+9
View File
@@ -13,6 +13,15 @@ def serialize_image(image):
return {"url": image.file.url, "title": image.title}
class SEOImageSerializer(serializers.Serializer):
def to_representation(self, image):
data = serialize_image(image)
request = self.context.get("request")
if data and request:
data["url"] = request.build_absolute_uri(data["url"])
return data
class TeamMemberSerializer(serializers.Serializer):
id = serializers.IntegerField()
name = serializers.CharField()
+1 -1
View File
@@ -19,7 +19,7 @@ def notify_frontend_revalidate(sender, instance, **kwargs):
try:
requests.post(
settings.FRONTEND_REVALIDATE_URL,
json={"tags": [f"page:{instance.id}", instance.url_path]},
json={"tags": ["wagtail-pages", f"page:{instance.id}", instance.url_path]},
headers={"Authorization": f"Bearer {settings.REVALIDATE_SECRET}"},
timeout=3,
)
+43
View File
@@ -67,6 +67,48 @@ def test_form_block_api_representation_expands_fields():
assert result["form"]["fields"][1]["choices"] == ["产品咨询", "合作洽谈"]
def test_page_api_exposes_seo_fields(home_page):
from wagtail.models import Site
from wagtail.images import get_image_model
from wagtail.images.tests.utils import get_test_image_file
site = Site.objects.get(is_default_site=True)
site.root_page = home_page
site.save()
image = get_image_model().objects.create(title="Share", file=get_test_image_file())
page = SimpleContentPage(
title="SEO test", slug="seo-test", seo_title_override="SEO title",
seo_description_override="SEO description", canonical_url="https://example.com/seo-test",
schema_json={"@context": "https://schema.org", "@type": "WebPage"},
og_image=image, seo_title="Standard title", search_description="Standard description",
)
home_page.add_child(instance=page)
response = APIClient().get(
f"/api/v2/pages/{page.pk}/?fields=seo_title,search_description,seo_title_override,seo_description_override,og_image,canonical_url,schema_json"
)
assert response.status_code == 200
assert response.data["seo_title_override"] == "SEO title"
assert response.data["seo_description_override"] == "SEO description"
assert response.data["canonical_url"] == "https://example.com/seo-test"
assert response.data["schema_json"]["@type"] == "WebPage"
assert response.data["og_image"]["title"] == "Share"
assert response.data["og_image"]["url"].startswith("http://testserver/media/")
assert response.data["meta"]["seo_title"] == "Standard title"
assert response.data["meta"]["search_description"] == "Standard description"
def test_seo_image_serializer_returns_absolute_url():
from types import SimpleNamespace
from rest_framework.test import APIRequestFactory
from apps.core.serializers import SEOImageSerializer
image = SimpleNamespace(file=SimpleNamespace(url="/media/share.png"), title="Share")
request = APIRequestFactory().get("/api/v2/pages/")
assert SEOImageSerializer(image, context={"request": request}).data == {
"url": "http://testserver/media/share.png", "title": "Share",
}
def test_form_block_api_representation_handles_empty_form():
block = FormBlock()
result = block.get_api_representation({"form": None})
@@ -358,6 +400,7 @@ def test_notify_frontend_revalidate_posts_webhook_when_configured(
assert calls[0]["url"] == "https://frontend.example.com/api/revalidate"
assert calls[0]["headers"] == {"Authorization": "Bearer test-secret"}
assert f"page:{home_page.id}" in calls[0]["json"]["tags"]
assert "wagtail-pages" in calls[0]["json"]["tags"]
def test_notify_frontend_revalidate_swallows_request_exception(
+3
View File
@@ -7,6 +7,7 @@ from wagtail.search import index
from apps.core.blocks import COMMON_BLOCKS
from apps.core.models import SEOablePage
from apps.core.serializers import SEOImageSerializer
class ProductIndexPage(SEOablePage):
@@ -19,6 +20,7 @@ class ProductIndexPage(SEOablePage):
]
subpage_types = ["products.ProductPage"]
api_fields = SEOablePage.api_fields + [APIField("intro")]
parent_page_types = ["home.HomePage"]
class Meta:
@@ -60,6 +62,7 @@ class ProductPage(SEOablePage):
api_fields = SEOablePage.api_fields + [
APIField("summary"),
APIField("body"),
APIField("cover_image", serializer=SEOImageSerializer()),
]
parent_page_types = ["products.ProductIndexPage"]
+3
View File
@@ -7,6 +7,7 @@ from wagtail.search import index
from apps.core.blocks import COMMON_BLOCKS
from apps.core.models import SEOablePage
from apps.core.serializers import SEOImageSerializer
class SolutionIndexPage(SEOablePage):
@@ -19,6 +20,7 @@ class SolutionIndexPage(SEOablePage):
]
subpage_types = ["solutions.SolutionPage"]
api_fields = SEOablePage.api_fields + [APIField("intro")]
parent_page_types = ["home.HomePage"]
class Meta:
@@ -64,6 +66,7 @@ class SolutionPage(SEOablePage):
APIField("industry"),
APIField("summary"),
APIField("body"),
APIField("cover_image", serializer=SEOImageSerializer()),
]
parent_page_types = ["solutions.SolutionIndexPage"]