Support for own WorkflowState Extensions

[notdefine]

Hi @ilvalerione ,

I made me this helper Class to have to access common values in the WorkflowState:

namespace Mehrkanal\Chatbot\Workflow\Common;

use NeuronAI\Workflow\WorkflowState;

class StateHelper
{
    protected const FIRSTNAME_KEY = 'user_firstname';
    protected const LANGUAGE_KEY = 'language';


    public static function setFirstname(WorkflowState $state, string $firstname): void
    {
        $state->set(self::FIRSTNAME_KEY, $firstname);
    }

    public static function getFirstname(WorkflowState $state): string
    {
        return $state->get(self::FIRSTNAME_KEY, 'no name given');
    }

    public static function setLanguage(WorkflowState $state, string $language): void
    {
        $state->set(self::LANGUAGE_KEY, $language);
    }

    public static function getLanguage(WorkflowState $state): string
    {
        return $state->get(self::LANGUAGE_KEY, 'english');
    }
}

For a more structured way to organize data in the WorkflowState. But I would prefer this way:

class MyWorkflowState extends \NeuronAI\Workflow\WorkflowState {
    protected const FIRSTNAME_KEY = 'user_firstname';
    protected const LANGUAGE_KEY = 'language';
    
    public function setFirstname(string $firstname):void {
         $this->set(self::FIRSTNAME_KEY, $firstname);
    }
    public function getFirstname():string {
        return $this->get(self::FIRSTNAME_KEY, $firstname);
    }

}

But this does not work, because WorkflowInterrupt has this code

    public function __unserialize(array $data): void
    {
        $this->message = $data['message'];
        $this->data = $data['data'];
        $this->currentNode = \unserialize($data['currentNode']);
        $this->state = new WorkflowState($data['state']);                <= here
        $this->currentEvent = \unserialize($data['currentEvent']);
    }

which did not allow to use my own State. Would it be helpfull to allow own WorkflowState Objects?

Greetings Thomas

[lamberttraccard]

I had the same interrogations, and I don't see how it could work with https://github.com/neuron-core/neuron-ai/releases/tag/2.2.7

[ilvalerione]

So when workflow wakes up it turns to the raw state class instead of your custom class intance. Great report. Let me check.

[ilvalerione]

Fixed in the 2.4.2

It stores the original state class in a dedicated field: https://github.com/neuron-core/neuron-ai/blob/2.x/src/Workflow/WorkflowInterrupt.php#L47

Use it on deserialization to restore the original object: https://github.com/neuron-core/neuron-ai/blob/2.x/src/Workflow/WorkflowInterrupt.php#L62

Here is a test to verify it works: https://github.com/neuron-core/neuron-ai/blob/2.x/tests/Workflow/WorkflowInterruptTest.php#L243

[notdefine]

I test it @ilvalerione it works fine, thanks.