Contrib.social

Field workflow value condition doesn't properly handle workflow creation state

Open on Drupal.org →
Created on 21 December 2024, 4 months ago

Problem/Motivation

Using this module in a project, we noticed that when initially creating a node, the workflow field has a NULL value, and so wasn't properly picking up the "creation" state selection on the "Workflow field has value" condition, which actually has the worflow's creation state ID.

Steps to reproduce

  1. Create a trivial ECA model using the "Workflow field has value" condition:
    • Event: Determining entity field access (set it to a field on your node type)
    • Condition: Workflow field has value (set it to include the Creation state for the appropriate Workflow)
    • Action: Set a message
  2. Create a node of the appropriate type (node/add/node-type)
  3. You will never see the message

Proposed resolution

In the evaluate() method of the condition plugin, we can detect whether a given state is the workflow state for its workflow, but this also requires knowing which workflow the state came from. There's a better solution for this, but I have a working patch at the moment which simply looks for states the end with "_creation" because that's the string the Workflow module appends to creation states when it (ahem) creates them.

Ultimately, I think a fulsome solution here would also resolve some usability issues with the configuration form for the Condition plugin. When there are multiple Workflows in the system (a less common scenario, but still), it's currently impossible to tell which state goes with which. I have added a small patch to prefix the Workflow to our State options in the configuration form, but again, it would seem better to first select the Workflow (default and disable the option if there's only 1), and then populate the states options with only ones from the selected Workflow.

Remaining tasks

  1. Upload overall patch to illustrate quick fixes for usability and handling creation states.
  2. Revise evaluate() patch to check if the expected state is a "creation state" by using the "isCreationState()" method.
  3. Split config schema to store Workflow *and* State (for now, don't limit state options)
  4. Add AJAX callback and rebuild form so that State options are limited to selected Workflow

  5. User interface changes

    Initially, the quick fix patch changes the interface for the configuration screen for the "Workflow field has value" condition plugin. It adds a Prefix to each State option to indicate which Workflow it goes with.

    Later, this options list in the configuration screen will be split into 2 fields: one to select which Workflow the state you want to compare for, and the other to select the State value itself.

    API changes

    None.

    Data model changes

    The config schema will end up changing to include another value for the selected Workflow.

🐛 Bug report
Status

Active

Version

1.0

Component

Code

Created by

🇨🇦Canada spiderman Halifax, NS

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

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024