Contrib.social

Incompatible with content moderation - nodes are never published

Open on Drupal.org →
Created on 4 May 2023, almost 2 years ago
Updated 10 May 2023, almost 2 years ago

The scheduler module appears to be incapable of publishing nodes when the core content_moderation module is enabled.

I spent a long time trying to debug it because everything scheduler was doing appears correct. But the problem is the content_moderation_entity_presave() hook which changes the status back to unpublished during saving.

The exact process is this:

modules/contrib/scheduler/src/SchedulerManager.php

$this->logger->notice('@type: scheduled publishing of %title.', $logger_variables);
$node->setPublished();

// ... snip

if ($loaded_action = $this->entityTypeManager->getStorage('action')->load($action_id)) {
  $loaded_action->getPlugin()->execute($node);
}

So $node has status set to 1 here, and then calls the core entity:publish_action.

core/lib/Drupal/Core/Action/Plugin/Action/PublishAction.php:

public function execute($entity = NULL) {
  $entity->setPublished()->save();
}

The entity:publish_action also sets status to 1 again, and saves the node. All good so far.

The presave hooks then fire, which means content_moderation_entity_presave() is called, which leads to the following.

core/modules/content_moderation/src/EntityOperations.php:

$this->entityTypeManager
  ->getHandler($entity->getEntityTypeId(), 'moderation')
  ->onPresave($entity, $update_default_revision, $current_state->isPublishedState());

The third argument to onPresave() is FALSE because the current workflow state is 'draft'.

core/modules/content_moderation/src/Entity/Handler/ModerationHandler.php:

public function onPresave(ContentEntityInterface $entity, $default_revision, $published_state) {
  // ... snip

  // Update publishing status if it can be updated and if it needs updating.
  if (($entity instanceof EntityPublishedInterface) && $entity->isPublished() !== $published_state) {
    $published_state ? $entity->setPublished() : $entity->setUnpublished();
  }
}

The condition here evaluates to FALSE because $entity->isPublished() is TRUE (set earlier by scheduler module) whereas $published_state determined by the workflow is FALSE. So the content moderation module will call $entity->setUnpublished() and thus the node is never published but the scheduler module thinks it has just published it.

✨ Feature request
Status

Active

Version

2.0

Component

Code

Created by

🇬🇧United Kingdom Rob230

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @Rob230
  • Comment almost 2 years ago →
    🇧🇷Brazil adrianopulz Florianópolis

    I'm facing the same issue with the unpublish action. Checking the logs all looks good, Drupal CRON runs and the message is that the node was unpublished, but the node is still published.

  • Comment almost 2 years ago →
    🇬🇧United Kingdom jonathan1055

    Hi Rob230 and adrianopulz,
    Are you using the Scheduler Content Moderation Integration → module? This is a necessary requirement for the functionality to work. If this is the case, just install that module and you will be fine.

    This is explained on the Scheduler front page, but I wonder if there is some way that Scheduler could detect that scheduling is being attemped on content that is moderated and the content moderation integration module is missing. Then we could give a helpful message.

  • Comment almost 2 years ago →
    🇬🇧United Kingdom Rob230

    Thank you that has solved it. I did think there must be a module but I assumed it would be a submodule so just checked on the Extend page.

    Perhaps a warning could be a good idea.

  • Comment almost 2 years ago →
    🇬🇧United Kingdom jonathan1055

    Thanks for the feedback, very pleased this solved your problem.

    I will try to work out a good way to point people to SCMI. For historical reasons it was developed as a separate module to allow another set of developers to have full control of it, at a point when I could not take responsibility (being the sole active maintainer of Scheduler).

    One option would be to create a dummy sub-module within Scheduler, that users would find when they go to the 'extend' page like you did. This would have no active source but just a dependency on the actual Scheduler Content Moderation Integration module. If the site also has Module Filter → installed then the missing module name will be converted into a link ✨ Create an outgoing link on missing modules Fixed to the drupal.org project page.

    Another option would be to detect when moderated content is being edited and scheduling is enabled but SCMI is not enabled, and give a message.

  • Comment almost 2 years ago →
    🇧🇷Brazil adrianopulz Florianópolis

    Thanks jonathan1055! That has solved the problem.

    I didn't see that on the home page, I went direct to the issues list... A message when the Moderation module is enabled will be very helpful.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024