wagtail 5.2.6__py3-none-any.whl → 5.2.8__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -135,6 +135,33 @@ class TestWorkflowsIndexView(AdminTemplateTestUtils, WagtailTestUtils, TestCase)
135
135
  self.assertNotContains(response, "There are no enabled workflows.")
136
136
  self.assertContains(response, "test_workflow")
137
137
 
138
+ def test_multiple_snippets_assigned_to_workflow(self):
139
+ Workflow.objects.create(name="Nocontenttypes")
140
+ multi_ct_workflow = Workflow.objects.create(name="Multicontenttypes")
141
+ for model in [FullFeaturedSnippet, ModeratedModel]:
142
+ WorkflowContentType.objects.create(
143
+ workflow=multi_ct_workflow,
144
+ content_type=ContentType.objects.get_for_model(model),
145
+ )
146
+
147
+ response = self.get()
148
+ self.assertEqual(response.status_code, 200)
149
+ soup = self.get_soup(response.content)
150
+ cells = [
151
+ text
152
+ for td in soup.select("td")
153
+ if (text := td.get_text(separator=" | ", strip=True))
154
+ ]
155
+ self.assertEqual(
156
+ cells,
157
+ [
158
+ "Multicontenttypes",
159
+ "0 pages | 2 snippet types",
160
+ "Nocontenttypes",
161
+ "0 pages | 0 snippet types",
162
+ ],
163
+ )
164
+
138
165
  def test_deactivated(self):
139
166
  Workflow.objects.create(name="test_workflow", active=False)
140
167
 
@@ -2,7 +2,7 @@ from django.contrib.contenttypes.models import ContentType
2
2
  from django.core.exceptions import PermissionDenied
3
3
  from django.core.paginator import Paginator
4
4
  from django.db import transaction
5
- from django.db.models import Count, OuterRef
5
+ from django.db.models import Count
6
6
  from django.db.models.functions import Lower
7
7
  from django.http import Http404, HttpResponseBadRequest
8
8
  from django.shortcuts import get_object_or_404, redirect, render
@@ -34,7 +34,6 @@ from wagtail.models import (
34
34
  Task,
35
35
  TaskState,
36
36
  Workflow,
37
- WorkflowContentType,
38
37
  WorkflowState,
39
38
  )
40
39
  from wagtail.permission_policies.pages import PagePermissionPolicy
@@ -64,10 +63,7 @@ class Index(IndexView):
64
63
  queryset = super().get_queryset()
65
64
  if not self.show_disabled():
66
65
  queryset = queryset.filter(active=True)
67
- content_types = WorkflowContentType.objects.filter(
68
- workflow=OuterRef("pk")
69
- ).values_list("pk", flat=True)
70
- queryset = queryset.annotate(content_types=Count(content_types))
66
+ queryset = queryset.annotate(content_types=Count("workflow_content_types"))
71
67
  return queryset
72
68
 
73
69
  def get_context_data(self, **kwargs):
@@ -110,6 +110,8 @@ class MigrateStreamData(RunPython):
110
110
 
111
111
  updated_model_instances_buffer = []
112
112
  for instance in model_queryset.iterator(chunk_size=self.chunk_size):
113
+ if instance.raw_content is None:
114
+ continue
113
115
 
114
116
  revision_query_maker.append_instance_data_for_revision_query(instance)
115
117
 
@@ -153,29 +153,29 @@ class StreamChildrenToListBlockOperation(BaseBlockOperation):
153
153
  super().__init__()
154
154
  self.block_name = block_name
155
155
  self.list_block_name = list_block_name
156
- self.temp_blocks = []
157
156
 
158
157
  def apply(self, block_value):
158
+ candidate_blocks = []
159
159
  mapped_block_value = []
160
160
  for child_block in block_value:
161
161
  if child_block["type"] == self.block_name:
162
- self.temp_blocks.append(child_block)
162
+ candidate_blocks.append(child_block)
163
163
  else:
164
164
  mapped_block_value.append(child_block)
165
165
 
166
- self.map_temp_blocks_to_list_items()
166
+ list_items = self.map_temp_blocks_to_list_items(candidate_blocks)
167
167
 
168
- if self.temp_blocks:
169
- new_list_block = {"type": self.list_block_name, "value": self.temp_blocks}
168
+ if list_items:
169
+ new_list_block = {"type": self.list_block_name, "value": list_items}
170
170
  mapped_block_value.append(new_list_block)
171
171
 
172
172
  return mapped_block_value
173
173
 
174
- def map_temp_blocks_to_list_items(self):
175
- new_temp_blocks = []
176
- for block in self.temp_blocks:
177
- new_temp_blocks.append({**block, "type": "item"})
178
- self.temp_blocks = new_temp_blocks
174
+ def map_temp_blocks_to_list_items(self, blocks):
175
+ list_items = []
176
+ for block in blocks:
177
+ list_items.append({**block, "type": "item"})
178
+ return list_items
179
179
 
180
180
  @property
181
181
  def operation_name_fragment(self):
@@ -653,7 +653,7 @@ class StreamValue(MutableSequence):
653
653
  raw_values = OrderedDict(
654
654
  (i, raw_item["value"])
655
655
  for i, raw_item in enumerate(self._raw_data)
656
- if raw_item["type"] == type_name and self._bound_blocks[i] is None
656
+ if self._bound_blocks[i] is None and raw_item["type"] == type_name
657
657
  )
658
658
  # pass the raw block values to bulk_to_python as a list
659
659
  converted_values = child_block.bulk_to_python(raw_values.values())
@@ -611,11 +611,13 @@ class TestFormPageWithCustomFormBuilder(WagtailTestUtils, TestCase):
611
611
  html=True,
612
612
  )
613
613
  # check ip address field has rendered
614
- self.assertContains(
615
- response,
616
- '<input type="text" name="device_ip_address" required id="id_device_ip_address" />',
617
- html=True,
618
- )
614
+ # (not comparing HTML directly because https://docs.djangoproject.com/en/5.1/releases/5.1.5/
615
+ # added a maxlength attribute)
616
+ soup = self.get_soup(response.content)
617
+ input = soup.find("input", {"name": "device_ip_address"})
618
+ self.assertEqual(input["type"], "text")
619
+ self.assertEqual(input["required"], "")
620
+ self.assertEqual(input["id"], "id_device_ip_address")
619
621
 
620
622
  def test_post_invalid_form(self):
621
623
  response = self.client.post(
@@ -1,3 +1,4 @@
1
+ import re
1
2
  import warnings
2
3
  from collections import OrderedDict
3
4
 
@@ -336,9 +337,12 @@ class MySQLSearchQueryCompiler(BaseSearchQueryCompiler):
336
337
 
337
338
  def build_search_query_content(self, query, invert=False):
338
339
  if isinstance(query, PlainText):
339
- terms = query.query_string.split()
340
+ # For Boolean full text search queries in MySQL,
341
+ # non-alphanumeric characters act as separators
342
+ terms = [term for term in re.split(r"\W+", query.query_string) if term]
343
+
340
344
  if not terms:
341
- return None
345
+ return SearchQuery("")
342
346
 
343
347
  last_term = terms.pop()
344
348
 
@@ -68,6 +68,81 @@ class TestMySQLSearchBackend(BackendTests, TransactionTestCase):
68
68
  all_other_titles | {"JavaScript: The Definitive Guide"},
69
69
  )
70
70
 
71
+ def test_empty_search(self):
72
+ results = self.backend.search("", models.Book.objects.all())
73
+ self.assertSetEqual(
74
+ {r.title for r in results},
75
+ set(),
76
+ )
77
+
78
+ results = self.backend.search(" ", models.Book.objects.all())
79
+ self.assertSetEqual(
80
+ {r.title for r in results},
81
+ set(),
82
+ )
83
+
84
+ results = self.backend.search("*", models.Book.objects.all())
85
+ self.assertSetEqual(
86
+ {r.title for r in results},
87
+ set(),
88
+ )
89
+
90
+ def test_empty_autocomplete(self):
91
+ results = self.backend.autocomplete("", models.Book.objects.all())
92
+ self.assertSetEqual(
93
+ {r.title for r in results},
94
+ set(),
95
+ )
96
+
97
+ results = self.backend.autocomplete(" ", models.Book.objects.all())
98
+ self.assertSetEqual(
99
+ {r.title for r in results},
100
+ set(),
101
+ )
102
+
103
+ results = self.backend.autocomplete("*", models.Book.objects.all())
104
+ self.assertSetEqual(
105
+ {r.title for r in results},
106
+ set(),
107
+ )
108
+
109
+ def test_symbols_in_search_term(self):
110
+ # symbols as their own tokens should be ignored
111
+ results = self.backend.search("javascript @ parts", models.Book.objects.all())
112
+ self.assertSetEqual(
113
+ {r.title for r in results},
114
+ {"JavaScript: The good parts"},
115
+ )
116
+
117
+ results = self.backend.search("javascript parts @", models.Book.objects.all())
118
+ self.assertSetEqual(
119
+ {r.title for r in results},
120
+ {"JavaScript: The good parts"},
121
+ )
122
+
123
+ results = self.backend.search("@ javascript parts", models.Book.objects.all())
124
+ self.assertSetEqual(
125
+ {r.title for r in results},
126
+ {"JavaScript: The good parts"},
127
+ )
128
+
129
+ # tokens containing both symbols and alphanumerics should not be discarded
130
+ # or treated as equivalent to the same token without symbols
131
+ results = self.backend.search("java@script parts", models.Book.objects.all())
132
+ self.assertSetEqual(
133
+ {r.title for r in results},
134
+ set(),
135
+ )
136
+
137
+ def test_autocomplete_with_symbols(self):
138
+ # the * is not part of the autocomplete mechanism, but if someone includes it
139
+ # we want it to be gracefully ignored
140
+ results = self.backend.autocomplete("parts javasc*", models.Book.objects.all())
141
+ self.assertSetEqual(
142
+ {r.title for r in results},
143
+ {"JavaScript: The good parts"},
144
+ )
145
+
71
146
  @skip(
72
147
  "The MySQL backend doesn't support choosing individual fields for the search, only (body, title) or (autocomplete) fields may be searched."
73
148
  )
@@ -7,3 +7,13 @@ class WagtailSnippetsTestsAppConfig(AppConfig):
7
7
  name = "wagtail.test.snippets"
8
8
  label = "snippetstests"
9
9
  verbose_name = _("Wagtail snippets tests")
10
+
11
+ def ready(self):
12
+ # Test registration of permission order within the group permissions view,
13
+ # as per https://docs.wagtail.org/en/stable/extending/customizing_group_views.html#customizing-the-group-editor-permissions-ordering
14
+ # Invoking `register` from `ready` confirms that it does not perform any database queries -
15
+ # if it did, it would fail (on a standard test run without --keepdb at least) because the
16
+ # test database hasn't been migrated yet.
17
+ from wagtail.users.permission_order import register
18
+
19
+ register("snippetstests.fancysnippet", order=999)
@@ -10,7 +10,7 @@ class MigrationTestMixin:
10
10
  default_operation_and_block_path = []
11
11
  app_name = None
12
12
 
13
- def init_migration(self, revisions_from=None, operations_and_block_path=None):
13
+ def init_migration(self, revisions_from=None, operations_and_block_paths=None):
14
14
  migration = Migration(
15
15
  "test_migration", "wagtail_streamfield_migration_toolkit_test"
16
16
  )
@@ -18,7 +18,7 @@ class MigrationTestMixin:
18
18
  app_name=self.app_name,
19
19
  model_name=self.model.__name__,
20
20
  field_name="content",
21
- operations_and_block_paths=operations_and_block_path
21
+ operations_and_block_paths=operations_and_block_paths
22
22
  or self.default_operation_and_block_path,
23
23
  revisions_from=revisions_from,
24
24
  )
@@ -29,11 +29,11 @@ class MigrationTestMixin:
29
29
  def apply_migration(
30
30
  self,
31
31
  revisions_from=None,
32
- operations_and_block_path=None,
32
+ operations_and_block_paths=None,
33
33
  ):
34
34
  migration = self.init_migration(
35
35
  revisions_from=revisions_from,
36
- operations_and_block_path=operations_and_block_path,
36
+ operations_and_block_paths=operations_and_block_paths,
37
37
  )
38
38
 
39
39
  loader = MigrationLoader(connection=connection)
@@ -13,35 +13,35 @@ class MigrationNameTest(TestCase, MigrationTestMixin):
13
13
  app_name = "wagtail_streamfield_migration_toolkit_test"
14
14
 
15
15
  def test_rename(self):
16
- operations_and_block_path = [
16
+ operations_and_block_paths = [
17
17
  (
18
18
  RenameStreamChildrenOperation(old_name="char1", new_name="renamed1"),
19
19
  "",
20
20
  )
21
21
  ]
22
22
  migration = self.init_migration(
23
- operations_and_block_path=operations_and_block_path
23
+ operations_and_block_paths=operations_and_block_paths
24
24
  )
25
25
 
26
26
  suggested_name = migration.suggest_name()
27
27
  self.assertEqual(suggested_name, "rename_char1_to_renamed1")
28
28
 
29
29
  def test_remove(self):
30
- operations_and_block_path = [
30
+ operations_and_block_paths = [
31
31
  (
32
32
  RemoveStreamChildrenOperation(name="char1"),
33
33
  "",
34
34
  )
35
35
  ]
36
36
  migration = self.init_migration(
37
- operations_and_block_path=operations_and_block_path
37
+ operations_and_block_paths=operations_and_block_paths
38
38
  )
39
39
 
40
40
  suggested_name = migration.suggest_name()
41
41
  self.assertEqual(suggested_name, "remove_char1")
42
42
 
43
43
  def test_multiple(self):
44
- operations_and_block_path = [
44
+ operations_and_block_paths = [
45
45
  (
46
46
  RenameStreamChildrenOperation(old_name="char1", new_name="renamed1"),
47
47
  "",
@@ -52,7 +52,7 @@ class MigrationNameTest(TestCase, MigrationTestMixin):
52
52
  ),
53
53
  ]
54
54
  migration = self.init_migration(
55
- operations_and_block_path=operations_and_block_path
55
+ operations_and_block_paths=operations_and_block_paths
56
56
  )
57
57
 
58
58
  suggested_name = migration.suggest_name()
@@ -1,12 +1,16 @@
1
1
  import datetime
2
2
  import json
3
3
 
4
- from django.db.models import F, JSONField
4
+ from django.db import connection
5
+ from django.db.models import F, JSONField, TextField
5
6
  from django.db.models.functions import Cast
6
7
  from django.test import TestCase
7
8
  from django.utils import timezone
8
9
 
9
- from wagtail.blocks.migrations.operations import RenameStreamChildrenOperation
10
+ from wagtail.blocks.migrations.operations import (
11
+ RenameStreamChildrenOperation,
12
+ StreamChildrenToListBlockOperation,
13
+ )
10
14
  from wagtail.test.streamfield_migrations import factories, models
11
15
  from wagtail.test.streamfield_migrations.testutils import MigrationTestMixin
12
16
 
@@ -24,8 +28,8 @@ class BaseMigrationTest(TestCase, MigrationTestMixin):
24
28
  ]
25
29
  app_name = None
26
30
 
27
- def setUp(self):
28
- instances = [
31
+ def _get_test_instances(self):
32
+ return [
29
33
  self.factory(
30
34
  content__0__char1="Test char 1",
31
35
  content__1__char1="Test char 2",
@@ -44,6 +48,9 @@ class BaseMigrationTest(TestCase, MigrationTestMixin):
44
48
  ),
45
49
  ]
46
50
 
51
+ def setUp(self):
52
+ instances = self._get_test_instances()
53
+
47
54
  self.original_raw_data = {}
48
55
  self.original_revisions = {}
49
56
 
@@ -102,9 +109,7 @@ class BaseMigrationTest(TestCase, MigrationTestMixin):
102
109
 
103
110
  self.apply_migration()
104
111
 
105
- instances = self.model.objects.all().annotate(
106
- raw_content=Cast(F("content"), JSONField())
107
- )
112
+ instances = self.model.objects.all()
108
113
 
109
114
  for instance in instances:
110
115
  old_revisions = self.original_revisions[instance.id]
@@ -128,9 +133,7 @@ class BaseMigrationTest(TestCase, MigrationTestMixin):
128
133
  revisions_from = timezone.now() + datetime.timedelta(days=2)
129
134
  self.apply_migration(revisions_from=revisions_from)
130
135
 
131
- instances = self.model.objects.all().annotate(
132
- raw_content=Cast(F("content"), JSONField())
133
- )
136
+ instances = self.model.objects.all()
134
137
 
135
138
  for instance in instances:
136
139
  old_revisions = self.original_revisions[instance.id]
@@ -159,9 +162,7 @@ class BaseMigrationTest(TestCase, MigrationTestMixin):
159
162
  revisions_from = timezone.now() - datetime.timedelta(days=2)
160
163
  self.apply_migration(revisions_from=revisions_from)
161
164
 
162
- instances = self.model.objects.all().annotate(
163
- raw_content=Cast(F("content"), JSONField())
164
- )
165
+ instances = self.model.objects.all()
165
166
 
166
167
  for instance in instances:
167
168
  old_revisions = self.original_revisions[instance.id]
@@ -209,3 +210,88 @@ class TestPage(BaseMigrationTest):
209
210
 
210
211
  def test_migrate_revisions_from_date(self):
211
212
  self._test_migrate_revisions_from_date()
213
+
214
+
215
+ class TestNullStreamField(BaseMigrationTest):
216
+ """
217
+ Migrations are processed if the underlying JSON is null.
218
+
219
+ This might occur if we're operating on a StreamField that was added to a model that
220
+ had existing records.
221
+ """
222
+
223
+ model = models.SamplePage
224
+ factory = factories.SamplePageFactory
225
+ has_revisions = True
226
+ app_name = "streamfield_migration_tests"
227
+
228
+ def _get_test_instances(self):
229
+ return self.factory.create_batch(1, content=None)
230
+
231
+ def setUp(self):
232
+ super().setUp()
233
+
234
+ # Bypass StreamField/StreamBlock processing that cast a None stream field value
235
+ # to the empty StreamValue, and set the underlying JSON to null.
236
+ with connection.cursor() as cursor:
237
+ cursor.execute(f"UPDATE {self.model._meta.db_table} SET content = 'null'")
238
+
239
+ def assert_null_content(self):
240
+ """
241
+ The raw JSON of all instances for this test is null.
242
+ """
243
+
244
+ instances = self.model.objects.all().annotate(
245
+ raw_content=Cast(F("content"), TextField())
246
+ )
247
+
248
+ for instance in instances:
249
+ with self.subTest(instance=instance):
250
+ self.assertEqual(instance.raw_content, "null")
251
+
252
+ def test_migrate_stream_data(self):
253
+ self.assert_null_content()
254
+ self.apply_migration()
255
+ self.assert_null_content()
256
+
257
+
258
+ class StreamChildrenToListBlockOperationTestCase(BaseMigrationTest):
259
+ model = models.SamplePage
260
+ factory = factories.SamplePageFactory
261
+ has_revisions = True
262
+ app_name = "streamfield_migration_tests"
263
+
264
+ def _get_test_instances(self):
265
+ return self.factory.create_batch(
266
+ size=3,
267
+ # Each content stream field has a single char block instance.
268
+ content__0__char1__value="Char Block 1",
269
+ )
270
+
271
+ def test_state_not_shared_across_instances(self):
272
+ """
273
+ StreamChildrenToListBlockOperation doesn't share state across model instances.
274
+
275
+ As a single operation instance is used to transform the data of multiple model
276
+ instances, we should not store model instance state on the operation instance.
277
+ See https://github.com/wagtail/wagtail/issues/12391.
278
+ """
279
+
280
+ self.apply_migration(
281
+ operations_and_block_paths=[
282
+ (
283
+ StreamChildrenToListBlockOperation(
284
+ block_name="char1", list_block_name="list1"
285
+ ),
286
+ "",
287
+ )
288
+ ]
289
+ )
290
+ for instance in self.model.objects.all().annotate(
291
+ raw_content=Cast(F("content"), JSONField())
292
+ ):
293
+ new_block = instance.raw_content[0]
294
+ self.assertEqual(new_block["type"], "list1")
295
+ self.assertEqual(len(new_block["value"]), 1)
296
+ self.assertEqual(new_block["value"][0]["type"], "item")
297
+ self.assertEqual(new_block["value"][0]["value"], "Char Block 1")
@@ -237,6 +237,24 @@ class TestStreamValueAccess(TestCase):
237
237
  self.assertEqual(fetched_body[1].block_type, "text")
238
238
  self.assertEqual(fetched_body[1].value, "bar")
239
239
 
240
+ def test_can_append_on_queried_instance(self):
241
+ # The test is analog to test_can_append(), but instead of working with the
242
+ # in-memory version from JSONStreamModel.objects.create(), we query a fresh
243
+ # instance from the db.
244
+ # It tests adding data to child blocks that
245
+ # have not yet been lazy loaded. This would previously crash.
246
+ self.json_body = JSONStreamModel.objects.get(pk=self.json_body.pk)
247
+ self.json_body.body.append(("text", "bar"))
248
+ self.json_body.save()
249
+
250
+ fetched_body = JSONStreamModel.objects.get(id=self.json_body.id).body
251
+ self.assertIsInstance(fetched_body, StreamValue)
252
+ self.assertEqual(len(fetched_body), 2)
253
+ self.assertEqual(fetched_body[0].block_type, "text")
254
+ self.assertEqual(fetched_body[0].value, "foo")
255
+ self.assertEqual(fetched_body[1].block_type, "text")
256
+ self.assertEqual(fetched_body[1].value, "bar")
257
+
240
258
 
241
259
  class TestStreamFieldRenderingBase(TestCase):
242
260
  model = JSONStreamModel
@@ -2,6 +2,7 @@ from django.contrib.contenttypes.models import ContentType
2
2
 
3
3
  from wagtail.coreutils import resolve_model_string
4
4
 
5
+ content_types_to_register = []
5
6
  CONTENT_TYPE_ORDER = {}
6
7
 
7
8
 
@@ -13,5 +14,18 @@ def register(model, **kwargs):
13
14
  """
14
15
  order = kwargs.pop("order", None)
15
16
  if order is not None:
16
- content_type = ContentType.objects.get_for_model(resolve_model_string(model))
17
- CONTENT_TYPE_ORDER[content_type.id] = order
17
+ # We typically call this at application startup, when the database may not be ready,
18
+ # and so we can't look up the content type yet. Instead we will queue up the
19
+ # (model, order) pair to be processed when the lookup is requested.
20
+ content_types_to_register.append((model, order))
21
+
22
+
23
+ def get_content_type_order_lookup():
24
+ if content_types_to_register:
25
+ for model, order in content_types_to_register:
26
+ content_type = ContentType.objects.get_for_model(
27
+ resolve_model_string(model)
28
+ )
29
+ CONTENT_TYPE_ORDER[content_type.id] = order
30
+ content_types_to_register.clear()
31
+ return CONTENT_TYPE_ORDER
@@ -4,7 +4,7 @@ import re
4
4
  from django import template
5
5
 
6
6
  from wagtail import hooks
7
- from wagtail.users.permission_order import CONTENT_TYPE_ORDER
7
+ from wagtail.users.permission_order import get_content_type_order_lookup
8
8
 
9
9
  register = template.Library()
10
10
 
@@ -42,9 +42,10 @@ def format_permissions(permission_bound_field):
42
42
  # get a distinct and ordered list of the content types that these permissions relate to.
43
43
  # relies on Permission model default ordering, dict.fromkeys() retaining that order
44
44
  # from the queryset, and the stability of sorted().
45
+ content_type_order = get_content_type_order_lookup()
45
46
  content_type_ids = sorted(
46
47
  dict.fromkeys(permissions.values_list("content_type_id", flat=True)),
47
- key=lambda ct: CONTENT_TYPE_ORDER.get(ct, float("inf")),
48
+ key=lambda ct: content_type_order.get(ct, float("inf")),
48
49
  )
49
50
 
50
51
  # iterate over permission_bound_field to build a lookup of individual renderable
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: wagtail
3
- Version: 5.2.6
3
+ Version: 5.2.8
4
4
  Summary: A Django content management system.
5
5
  Home-page: https://wagtail.org/
6
6
  Author: Wagtail core team + contributors