Cache not invalidated when using a PlaceholderField outside the CMS #6912

[pierreben]

Description

Since v3.6.0, when using a PlaceholderField outside the CMS, the cache is not invalidated when updating the placeholder content.
On this commit, the value of the clear_cache attribute changed from True to False, and the clear_cache method is never called in this case.

I've created a new pull request as the previous was invalid and added tests.

Related resources

• 9988097#diff-5c9765ac0e61c2e87b3cea96392a6df2L1117
• https://github.com/divio/django-cms/blob/release/3.7.x/cms/models/placeholdermodel.py#L499
• When updating a blog post cache is not invalidated nephila/djangocms-blog#484

Steps to reproduce

1. Create a custom model containing a PlaceholderField

class MyModel(models.Model):
    body_placeholder = PlaceholderField("Body")

2. Activate CACHE on the CMS

CMS_CACHE_DURATIONS = {
    "menus": 3600,
    "content": 3600,
    "permissions": 3600
}

3. Create a MyModel instance, a view and template to display it

4. Edit the my_model_object placeholder field content within a template using the render_placeholder template tag:

{% render_placeholder my_model_object.body_placeholder %}

5. Open the MyModel instance view in a private session to compare the content.

6. Repeat steps 4 and 5 twice if the content doesn't differs.

Expected behaviour

The contents are always the same between the two browser sessions.

Actual behaviour

The contents differs as the cache is not invalidated when updating the body_placeholder content.

Suggested correction

In the mark_as_dirty method, force clear_cache when the attached model is not a Page or a StaticPlaceholder.

Checklist

• I have opened this pull request against develop
• I have updated the CHANGELOG.rst
• I have added or modified the tests when changing logic

[pierreben]

Any news on this issue ?

It affects all ours projects using djangocms-blog as described in this related issue :(

[Aiky30]

@pierreben My apologies that it has taken this long to review your change. This looks good and I'm grateful that you have also provided a test.

Can you please add a changelog entry into the changelog, this ensures that we mention your fix in any official releases.

Once this has a changelog entry int he unreleased section of the changelog I will approve this change, once approved we can start to look at getting it merged and released.

Again thank you for your effort regarding this fix.

[pierreben]

@Aiky30 , thank you for the fix analysis.

I've updated the changelog ;)

[palmitoto]

Why this MR is not yet merged ? Django-cms is not working without that patch.

A solution is provided since December 2020, it's too long to patch a critical issue like that.

[NicolaiRidani]

Why this MR is not yet merged ? Django-cms is not working without that patch.

A solution is provided since December 2020, it's too long to patch a critical issue like that.

Hi @palmitoto I can understand your annoyance about the delay. Unfortunately, we are not in a good position at the moment in terms of resources, plus there is a problem with Travis that we are working on solving. But rest assured that we will try to resolve this quickly.

With the founding of the django CMS Association, we have started an initiative that aims to foster contribution. Among many other community groups, we also have a work group for reviewing pull requests and a work group that takes care of release management. Both teams are happy to receive any support. We invite everyone to join us!

If you want to learn more, feel free to contact me, otherwise more information can be found here:

You are also welcome to join our Slack channel: www.django-cms.org/slack to get in touch with the team.

Best
Nicolai

[greengoaxe]

Hi @Aiky30,
may you review and approved it?
Thanks,
greengoaxe

[goutnet]

@Aiky30 since we are trying to make the Changelog happen more automatically, and based on your comments, I am updating the branch and schedule this one for merge.

will add the changelog entry directly from squash commit

[goutnet]

merged! and right in time for 3.9.0!