Trigger task-modified-event on tag- and/or metadata-change

a.dieterle · January 12, 2023, 1:45pm

Hi. Is there a way to let kanboard detect a change of tags and/or metadata change when saving a task?
This is neccassary to use automatic actions with TASK_MODIFIED for automatic logging. We use tags to visualize that a customer has been reminded to react on an e-mail. Now it would be helpful to log this reminding action in the description. Currenty a change of tags and metadata doesn’t seem to be logged anywhere.

Thanks for any ideas!

creecros · January 12, 2023, 10:52pm

Same as asking:
"I have an extra room upstairs, is there a way to add a sink and toilet, to make a bathroom out of it? "

Yes, is the answer, to both questions. Not sure your expectations on that answer though.

a.dieterle · January 16, 2023, 7:00am

Thanks for the reply! Everything is possible for those who believe. Sometimes I kind of forget that.

But I thought I had a bathroom with a sink and toilet. I wanted to connect my washing machine now, because I thought there should be a connection normally. Unfortunately, I’m not a plumber, so I’m not sure if I a) just did not recognize the connection or b) need an adapter for the inlet and outlet of the sink.

In terms of kanboard, my understanding, as written, is that TASK_MODIFIED seems to be the key to triggering an automatic action when a task is saved. In my second life, I do tinker around with C# scripts inside a game engine. However, I don’t understand enough about software architecture and especially php to be able to understand the kanboard’s cause-and-effect relationships.

So “Thanks for any ideas!” referred to possible solutions to estimate if triggering an automatic action by changing a tag is realistic for my level or not. Or in other words: “Check the washing machine connection again! It has to be there”, “You need an adapter, but think carefully about whether you want to install it yourself” or “Please don’t start knocking a huge hole in the wall to lay pipes on your own (especially not where power lines are laid). Call an installer for help!”?

Peace
AD

creecros · January 17, 2023, 2:00pm

Show me this “TASK_MODIFIED” event that you speak of.

These are the task events:

github.com

kanboard/kanboard/blob/2edb70873187e63090e5ab538e79e7a59d29cb92/app/Model/TaskModel.php#L35-L47


      
          const EVENT_MOVE_PROJECT = 'task.move.project';
          const EVENT_MOVE_COLUMN = 'task.move.column';
          const EVENT_MOVE_POSITION = 'task.move.position';
          const EVENT_MOVE_SWIMLANE = 'task.move.swimlane';
          const EVENT_UPDATE = 'task.update';
          const EVENT_CREATE = 'task.create';
          const EVENT_CLOSE = 'task.close';
          const EVENT_OPEN = 'task.open';
          const EVENT_CREATE_UPDATE = 'task.create_update';
          const EVENT_ASSIGNEE_CHANGE = 'task.assignee_change';
          const EVENT_OVERDUE = 'task.overdue';
          const EVENT_USER_MENTION = 'task.user.mention';
          const EVENT_DAILY_CRONJOB = 'task.cronjob.daily';

Now notice, in the TaskModificationModel:

github.com

kanboard/kanboard/blob/2edb70873187e63090e5ab538e79e7a59d29cb92/app/Model/TaskModificationModel.php#L53


      
           * @param  array $changes
           */
          protected function fireEvents(array $task, array $changes)
          {
              $events = array();
          
          
    if ($this->isAssigneeChanged($task, $changes)) {
                  $events[] = TaskModel::EVENT_ASSIGNEE_CHANGE;
              } elseif ($this->isModified($task, $changes)) {
                  $events[] = TaskModel::EVENT_CREATE_UPDATE;
                  $events[] = TaskModel::EVENT_UPDATE;
              }
          
          
    if (! empty($events)) {
                  $this->queueManager->push($this->taskEventJob
                      ->withParams($task['id'], $events, $changes, array(), $task)
                  );
              }
          }
          
          
/**

This handles the event, and triggers it, upon update. But the important thing to notice, is the comparison of values.

github.com

kanboard/kanboard/blob/2edb70873187e63090e5ab538e79e7a59d29cb92/app/Model/TaskModificationModel.php#L71


      
          }
          
          
/**
           * Return true if the task have been modified
           *
           * @access protected
           * @param  array $task
           * @param  array $changes
           * @return bool
           */
          protected function isModified(array $task, array $changes)
          {
              $diff = array_diff_assoc($changes, $task);
              unset($diff['date_modification']);
              return count($diff) > 0;
          }
          
          
/**
           * Return true if the field is the only modified value
           *
           * @access protected

Tags, are not included in that comparison, in short.

So, yes, you will need an adapter.

For some guidance, the only plugins I have done that deal with notifications are: (but this might be a bit different) They might help you.

a.dieterle · January 18, 2023, 7:40am

Thanks a lot! Yes, I dont’t know where the TASK_MODIFIED came from.
I did see this isModified function before but I wasn’t aware that TaskModificationModel.php was somehow overwritten by NewTaskModofocationModel.php in the MetaMagik Plugin. When replacing “elseif ($this->isModified($task, $changes))” with “else” in both files EVENT_UPDATE is triggered every time, the task card has been opened.

So for a clean way I have to figure our how to add some tagsModified and metaModified function and change the line in TaskModificationModel.php and NewTaskModificationModel.php to “elseif ($this->isModified($task, $changes) || tagsModified($task, $changes) || metaModified($task, $changes))”.

If I find out how to do this, I’m going to reply again.

Thanks a lot again!

a.dieterle · January 18, 2023, 7:42am

I mean “elseif ($this->isModified($task, $changes) || $this->tagsModified($task, $changes) || $this->metaModified($task, $changes))”

a.dieterle · January 31, 2023, 12:53pm

So the following changes in TaskModificationModel.php is what helped me detect changes in tags:

Changes_in_TaskModificationModel_fireEventsUnconditional

a.dieterle · January 31, 2023, 12:55pm

For changes with MetaMagik installed the changes need to be done in NewTaskModificationModel.php in the Model folder in the Plugin folder.

To detected changes in meta data the following changes helped me:
Changes_in_TaskModificationModel_updateMeta1

a.dieterle · January 31, 2023, 12:56pm

The first picture already shows the changes for tags and meta changes.

Topic		Replies	Views
Plugin dev : how to notify automatic actions into an automatic action Plugins	9	809	July 31, 2019
Add automatic action to copy subtask ou update tasks in another project	0	325	June 17, 2020
Prevent accidental loss of comments and changes Enhancements	5	259	October 16, 2023
Automatic Action: change the assignee if Category change Questions	2	156	March 30, 2023
Create automatic action from a subtask event	13	1271	September 6, 2019

Trigger task-modified-event on tag- and/or metadata-change

Related Topics