How are on-modify hooks run when multiple tasks are modified?

[gevhaz]

I wrote an on-modify hook, but I have issues when I do task done for more than one task.

My script assumes that it will get 2 lines of input, and it outputs one line, like described in the documentation: https://taskwarrior.org/docs/hooks/#interfaces

So I assume that the script is run once for each task, rather than all tasks being sent to it in a batch.

Steps to reproduce

Run task 1,2 done

Expected result

Status of tasks 1 and 2 are set to 'complete'.

Actual result

$ task 1,2 done
This command will alter 2 tasks.
Completed task 12721234 'test'.
Update task query

I.e. only one task is updated. The other remains as pending.

[smemsh]

The man page shows using multiple args to specify multiple IDs. It lists a few other ways, but none with commas. Could that be your issue? Although, any of these ways works for me.

I do think multiple tasks are given one at a time to multiple invocations of the hook, yes. Or, they were before... Are you sure your hook didn't give an error, which didn't output the update json for the second one?

[gevhaz]

Managed to activate debugging with:

debug.hooks=2

in ~/.taskrc (rather than rc.debug.hooks=2 like I had before). I can see that the hook exits successfully for both tasks. And I can confirm that it is run once per task. I can see that the output line looks correct for both of the tasks, even the second one.

I tried with the task 1 2 done format as well, but the result is the same.

[smemsh]

it works for me using the upstream-provided sample on-modify script. rc.debug.hooks also worked fine on command line for me.

 $ sudo useradd -UM tasktest
 $ sudo mkdir /home/tasktest
 $ sudo chown tasktest:tasktest /home/tasktest
 $ sudo su - tasktest
 
 $ task3 add testing1
A configuration file could not be found in /home/tasktest

Would you like a sample /home/tasktest/.taskrc created, so
  Taskwarrior can proceed? (yes/no) yes

Created task 1.

 $ task3 add testing2
Created task 2.

 $ cp /usr/local/share/doc/task/scripts/hooks/on-modify .task/hooks/
 $ chmod 0755 .task/hooks/on-modify
 $ task3 diag

task 3.0.2
   Platform: Linux

Compiler
    Version: 11.4.0
       Caps: +stdc +stdc_hosted +LP64 +c8 +i32 +l64 +vp64 +time_t64
 Compliance: C++17

Build Features
     Commit: 9cd1b96e1
      CMake: 3.22.1
    libuuid: libuuid + uuid_unparse_lower
 Build type: release

Configuration
       File: /home/tasktest/.taskrc (found), 780 bytes, mode 100664
       Data: /home/tasktest/.task (found), dir, mode 40775
    Locking: Enabled
         GC: Enabled
Hooks
     System: Enabled
   Location: /home/tasktest/.task/hooks
     Active: on-modify (executable)
   Inactive:

Tests
   Terminal: 246x54
       Dups: Scanned 2 tasks for duplicate UUIDs:
             No duplicates found
 Broken ref: Scanned 2 tasks for broken references:
             No broken references found


 $ task3 all

ID St UUID     Age  Description
 2 P  2b10f1d3 5min testing2
 1 P  7266e1ed 5min testing1

2 tasks

 $ task3 rc.debug.hooks=2 1 2 done
This command will alter 2 tasks.
Completed task 7266e1ed 'testing1'.
Completed task 2b10f1d3 'testing2'.
Completed 2 tasks.
Timer Config::load (/home/tasktest/.taskrc) 0.000515 sec
No context set
Found hook script /home/tasktest/.task/hooks/on-modify
Filtered 2 tasks --> 2 tasks [all tasks]
Hook: Calling /home/tasktest/.task/hooks/on-modify
Hook: input
  {"description":"testing1",
   "entry":"20240627T002944Z",
   "modified":"20240627T002944Z",
   "status":"pending",
   "uuid":"7266e1ed-6b29-445a-818f-10913fb5ec2c"}
  {"description":"testing1",
   "end":"20240627T003542Z",
   "entry":"20240627T002944Z",
   "modified":"20240627T003542Z",
   "status":"completed",
   "uuid":"7266e1ed-6b29-445a-818f-10913fb5ec2c"}
Hooks: args
  api:2
  args:task3 rc.debug.hooks=2 1 2 done
  command:done
  rc:/home/tasktest/.taskrc
  data:/home/tasktest/.task
  version:3.0.2
Timer Hooks::execute (/home/tasktest/.task/hooks/on-modify)
  0.000955 sec
Hook: output
  {"description":"testing1",
   "end":"20240627T003542Z",
   "entry":"20240627T002944Z",
   "modified":"20240627T003542Z",
   "status":"completed",
   "uuid":"7266e1ed-6b29-445a-818f-10913fb5ec2c"}
  on-modify
Hook: Completed with status 0

Hook: Calling /home/tasktest/.task/hooks/on-modify
Hook: input
  {"description":"testing2",
   "entry":"20240627T002949Z",
   "modified":"20240627T002949Z",
   "status":"pending",
   "uuid":"2b10f1d3-dd58-40a2-a5d6-f382bfda2431"}
  {"description":"testing2",
   "end":"20240627T003542Z",
   "entry":"20240627T002949Z",
   "modified":"20240627T003542Z",
   "status":"completed",
   "uuid":"2b10f1d3-dd58-40a2-a5d6-f382bfda2431"}
Hooks: args
  api:2
  args:task3 rc.debug.hooks=2 1 2 done
  command:done
  rc:/home/tasktest/.taskrc
  data:/home/tasktest/.task
  version:3.0.2
Timer Hooks::execute (/home/tasktest/.task/hooks/on-modify)
  0.001846 sec
Hook: output
  {"description":"testing2",
   "end":"20240627T003542Z",
   "entry":"20240627T002949Z",
   "modified":"20240627T003542Z",
   "status":"completed",
   "uuid":"2b10f1d3-dd58-40a2-a5d6-f382bfda2431"}
  on-modify
Hook: Completed with status 0

Perf task 3.0.2 9cd1b96e1 20240627T003542Z init:1891 load:0 gc:0
  filter:90 commit:0 sort:0 render:0 hooks:3042 other:123697
  total:128720

Configuration override rc.debug.hooks=2
on-modify

 $ task3 all

ID St UUID     Age  Done  Description
 - C  2b10f1d3 6min 24s   testing2
 - C  7266e1ed 6min 24s   testing1

2 tasks

[edited for wrap]