Wagtail项目中ModalWorkflow未定义错误的分析与解决

问题背景

在Wagtail项目升级过程中，开发者可能会遇到一个典型的JavaScript错误："ModalWorkflow is not defined"。这个错误通常出现在使用ImageChooserBlock等需要模态窗口功能的场景中，表现为点击"change image"按钮时没有任何反应，同时在浏览器控制台可以看到上述错误信息。

错误原因分析

该问题的根源在于Wagtail 6.0.2版本对前端资源加载方式进行了重构。在6.0.1及更早版本中，modal-workflow.js脚本是通过多个不同的模板文件加载的。而从6.0.2版本开始，Wagtail团队将这一脚本的加载统一移到了admin_base.html模板中（提交13153b50689cd42698b55482c7655ece9ace55da）。

当开发者直接复制并覆盖了admin_base.html模板，而不是通过继承方式扩展它时，就会导致在升级后缺少必要的JavaScript资源加载。这是因为直接覆盖的模板没有包含新版本中新增的资源引用，而继承方式可以自动获取父模板的所有内容。

解决方案

临时解决方案

对于急需解决问题的开发者，可以手动在相关模板中添加以下代码：

<script src="{% versioned_static 'wagtailadmin/js/modal-workflow.js' %}"></script>

推荐解决方案

遵循Django和Wagtail的最佳实践，应该通过模板继承的方式来定制admin界面：

1. 创建自定义的admin_base.html模板，首行必须继承Wagtail的原生模板：

{% extends "wagtailadmin/admin_base.html" %}

2. 只覆盖需要修改的block，而不是整个模板。例如，如果只需要修改品牌信息：

{% extends "wagtailadmin/admin_base.html" %}

{% block branding_title %}我的自定义网站名称{% endblock %}

3. 对于需要添加额外JavaScript的情况，使用extra_js块而不是覆盖整个js块：

{% block extra_js %}
    {{ block.super }}
    <!-- 自定义的JavaScript代码 -->
{% endblock %}

最佳实践建议

1. 避免直接覆盖核心模板：Wagtail的admin界面模板会随着版本更新而改变，直接覆盖会导致升级时出现问题。

2. 使用模板继承：通过继承并只覆盖特定block的方式，可以确保获取到Wagtail的所有更新，同时保留自定义内容。

3. 关注版本升级说明：在升级Wagtail版本前，仔细阅读发布说明，了解是否有模板结构的变更。

4. 测试环境先行：在将Wagtail升级应用到生产环境前，先在测试环境中验证所有功能是否正常。

通过遵循这些最佳实践，开发者可以避免类似ModalWorkflow未定义这样的问题，同时确保自定义内容能够与Wagtail的更新保持兼容。