Schedule publishing and deletion time

[mwinkens]

Being able to schedule announcements is a wished feature from the community, this is completely optional of course

Images:

App view:

Test user: (he only got the notification of a soon to be deleted announcement)

Features:

• UI for scheduling announcements (only in the future)
• UI for schdeule announcement deletion (only in the future)
• A background job accomplishing above
• new database entries for schedule_time, delete_time, groups (required for publishing) and notificationOptions, so you can notifiy over emails, nc-notifications, etc. in the future

closes #187
closes #677

possible milestone for #385

[nickvergessen]

I invited you to our org, so you can send the PR from with in, so it also automatically runs CI

[mwinkens]

I invited you to our org, so you can send the PR from with in, so it also automatically runs CI

Thank you! I hope I didn't cause too much traffic

[mwinkens]

@nickvergessen currently the background job is not being executed and I don't know why. When I re-enable the app, the job is added but as soon as you want to execute it, it gets deleted 🤔

I am pretty sure I set it up as described in the developer documentation, any ideas? I already set the loglevel to debug and added logging to the Service, but I didn't get any output.

mysql> select * from oc_jobs where class LIKE '%nnouncement%' ;
+-----+-------------------------------------------------+----------+------------+--------------+-------------+--------------------+----------------------------------+----------------+
| id  | class                                           | argument | last_run   | last_checked | reserved_at | execution_duration | argument_hash                    | time_sensitive |
+-----+-------------------------------------------------+----------+------------+--------------+-------------+--------------------+----------------------------------+----------------+
|  17 | OCA\NextcloudAnnouncements\Cron\Crawler         | null     | 1710231001 |   1710246001 |           0 |                  0 | 37a6259cc0c1dae299a7866489dff0bd |              1 |
| 195 | OCA\AnnouncementCenter\AnnouncementSchedulerJob | null     |          0 |   1710246080 |           0 |                  0 | 37a6259cc0c1dae299a7866489dff0bd |              1 |
+-----+-------------------------------------------------+----------+------------+--------------+-------------+--------------------+----------------------------------+----------------+

sudo -u www-data php occ background-job:list | grep nnouncement
| 17  | OCA\NextcloudAnnouncements\Cron\Crawler                         | 2024-03-12T08:10:01+00:00 | null     |

https://docs.nextcloud.com/server/latest/developer_manual/basics/backgroundjobs.html#writing-a-background-job

---

Edit: I found out, that the DependencyInjection is not working/not setup, because the services are not registered. This is also true for your custom Nofitier. I will implement this

https://docs.nextcloud.com/server/latest/developer_manual/basics/dependency_injection.html

[nickvergessen]

Edit: I found out, that the DependencyInjection is not working/not setup, because the services are not registered. This is also true for your custom Nofitier. I will implement this

https://docs.nextcloud.com/server/latest/developer_manual/basics/dependency_injection.html

This should only be needed in very rare circumstances and in fact in the code I see no reason why it would be needed in this case

[mwinkens]

Edit: I found out, that the DependencyInjection is not working/not setup, because the services are not registered. This is also true for your custom Nofitier. I will implement this
https://docs.nextcloud.com/server/latest/developer_manual/basics/dependency_injection.html

This should only be needed in very rare circumstances and in fact in the code I see no reason why it would be needed in this case

Should I remove this again? I noticed, that at least the Notifier needed to be added there, because I got a warning

{"reqId":"B2lvZSwcW2eEm61Gr5lJ","level":3,"time":"2024-03-12T15:41:04+00:00","remoteAddr":"127.0.0.1","user":"nextcloud27","app":"notifications","method":"GET","url":"/ocs/v2.php/apps/notifications/api/v2/notifications","message":"Failed to load notification notifier class: OCA\\AnnouncementCenter\\Notification\\Notifier","userAgent":"Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:122.0) Gecko/20100101 Firefox/122.0","version":"28.0.1.1","exception":{"Exception":"OCP\\AppFramework\\QueryException","Message":"Could not resolve OCA\\AnnouncementCenter\\AppInfo\\IConfig! Class \"OCA\\AnnouncementCenter\\AppInfo\\IConfig\" does not exist","Code":0,"Trace":[{"function":"OC\\AppFramework\\Utility\\{closure}","class":"OC\\AppFramework\\Utility\\SimpleContainer","type":"->","args":["*** sensitive parameters replaced ***"]},{"file":"/var/www/nextcloud28/lib/private/AppFramework/Utility/SimpleContainer.php","line":83,"function":"array_map"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/Utility/SimpleContainer.php","line":128,"function":"buildClass","class":"OC\\AppFramework\\Utility\\SimpleContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/Utility/SimpleContainer.php","line":146,"function":"resolve","class":"OC\\AppFramework\\Utility\\SimpleContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/DependencyInjection/DIContainer.php","line":468,"function":"query","class":"OC\\AppFramework\\Utility\\SimpleContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/ServerContainer.php","line":155,"function":"queryNoFallback","class":"OC\\AppFramework\\DependencyInjection\\DIContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/Utility/SimpleContainer.php","line":64,"function":"query","class":"OC\\ServerContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/Notification/Manager.php","line":173,"function":"get","class":"OC\\AppFramework\\Utility\\SimpleContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/Notification/Manager.php","line":364,"function":"getNotifiers","class":"OC\\Notification\\Manager","type":"->"},{"file":"/var/www/nextcloud28/apps/notifications/lib/Controller/EndpointController.php","line":118,"function":"prepare","class":"OC\\Notification\\Manager","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/Http/Dispatcher.php","line":230,"function":"listNotifications","class":"OCA\\Notifications\\Controller\\EndpointController","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/Http/Dispatcher.php","line":137,"function":"executeController","class":"OC\\AppFramework\\Http\\Dispatcher","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/App.php","line":184,"function":"dispatch","class":"OC\\AppFramework\\Http\\Dispatcher","type":"->"},{"file":"/var/www/nextcloud28/lib/private/Route/Router.php","line":315,"function":"main","class":"OC\\AppFramework\\App","type":"::"},{"file":"/var/www/nextcloud28/ocs/v1.php","line":65,"function":"match","class":"OC\\Route\\Router","type":"->"},{"file":"/var/www/nextcloud28/ocs/v2.php","line":23,"args":["/var/www/nextcloud28/ocs/v1.php"],"function":"require_once"}],"File":"/var/www/nextcloud28/lib/private/AppFramework/Utility/SimpleContainer.php","Line":114,"Previous":{"Exception":"OC\\AppFramework\\Utility\\QueryNotFoundException","Message":"Could not resolve OCA\\AnnouncementCenter\\AppInfo\\IConfig! Class \"OCA\\AnnouncementCenter\\AppInfo\\IConfig\" does not exist","Code":0,"Trace":[{"file":"/var/www/nextcloud28/lib/private/AppFramework/Utility/SimpleContainer.php","line":146,"function":"resolve","class":"OC\\AppFramework\\Utility\\SimpleContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/DependencyInjection/DIContainer.php","line":468,"function":"query","class":"OC\\AppFramework\\Utility\\SimpleContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/DependencyInjection/DIContainer.php","line":440,"function":"queryNoFallback","class":"OC\\AppFramework\\DependencyInjection\\DIContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/Utility/SimpleContainer.php","line":64,"function":"query","class":"OC\\AppFramework\\DependencyInjection\\DIContainer","type":"->"},{"file":"/home/marvin/workspace/announcementcenter/lib/AppInfo/Application.php","line":76,"function":"get","class":"OC\\AppFramework\\Utility\\SimpleContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/Utility/SimpleContainer.php","line":175,"function":"OCA\\AnnouncementCenter\\AppInfo\\{closure}","class":"OCA\\AnnouncementCenter\\AppInfo\\Application","type":"->","args":["*** sensitive parameters replaced ***"]},{"file":"/var/www/nextcloud28/3rdparty/pimple/pimple/src/Pimple/Container.php","line":122,"function":"OC\\AppFramework\\Utility\\{closure}","class":"OC\\AppFramework\\Utility\\SimpleContainer","type":"->","args":["*** sensitive parameters replaced ***"]},{"file":"/var/www/nextcloud28/lib/private/AppFramework/Utility/SimpleContainer.php","line":142,"function":"offsetGet","class":"Pimple\\Container","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/DependencyInjection/DIContainer.php","line":462,"function":"query","class":"OC\\AppFramework\\Utility\\SimpleContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/DependencyInjection/DIContainer.php","line":440,"function":"queryNoFallback","class":"OC\\AppFramework\\DependencyInjection\\DIContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/Utility/SimpleContainer.php","line":96,"function":"query","class":"OC\\AppFramework\\DependencyInjection\\DIContainer","type":"->"},{"function":"OC\\AppFramework\\Utility\\{closure}","class":"OC\\AppFramework\\Utility\\SimpleContainer","type":"->","args":["*** sensitive parameters replaced ***"]},{"file":"/var/www/nextcloud28/lib/private/AppFramework/Utility/SimpleContainer.php","line":83,"function":"array_map"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/Utility/SimpleContainer.php","line":128,"function":"buildClass","class":"OC\\AppFramework\\Utility\\SimpleContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/Utility/SimpleContainer.php","line":146,"function":"resolve","class":"OC\\AppFramework\\Utility\\SimpleContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/DependencyInjection/DIContainer.php","line":468,"function":"query","class":"OC\\AppFramework\\Utility\\SimpleContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/ServerContainer.php","line":155,"function":"queryNoFallback","class":"OC\\AppFramework\\DependencyInjection\\DIContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/Utility/SimpleContainer.php","line":64,"function":"query","class":"OC\\ServerContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/Notification/Manager.php","line":173,"function":"get","class":"OC\\AppFramework\\Utility\\SimpleContainer","type":"->"},{"file":"/var/www/nextcloud28/lib/private/Notification/Manager.php","line":364,"function":"getNotifiers","class":"OC\\Notification\\Manager","type":"->"},{"file":"/var/www/nextcloud28/apps/notifications/lib/Controller/EndpointController.php","line":118,"function":"prepare","class":"OC\\Notification\\Manager","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/Http/Dispatcher.php","line":230,"function":"listNotifications","class":"OCA\\Notifications\\Controller\\EndpointController","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/Http/Dispatcher.php","line":137,"function":"executeController","class":"OC\\AppFramework\\Http\\Dispatcher","type":"->"},{"file":"/var/www/nextcloud28/lib/private/AppFramework/App.php","line":184,"function":"dispatch","class":"OC\\AppFramework\\Http\\Dispatcher","type":"->"},{"file":"/var/www/nextcloud28/lib/private/Route/Router.php","line":315,"function":"main","class":"OC\\AppFramework\\App","type":"::"},{"file":"/var/www/nextcloud28/ocs/v1.php","line":65,"function":"match","class":"OC\\Route\\Router","type":"->"},{"file":"/var/www/nextcloud28/ocs/v2.php","line":23,"args":["/var/www/nextcloud28/ocs/v1.php"],"function":"require_once"}],"File":"/var/www/nextcloud28/lib/private/AppFramework/Utility/SimpleContainer.php","Line":135},"message":"Failed to load notification notifier class: OCA\\AnnouncementCenter\\Notification\\Notifier","exception":{},"CustomMessage":"Failed to load notification notifier class: OCA\\AnnouncementCenter\\Notification\\Notifier"}}

[nickvergessen]

Should I remove this again? I noticed, that at least the Notifier needed to be added there, because I got a warning

Yeah remove it again. It seems there is an import of use OCP\IConfig; missing somewhere instead.

[mwinkens]

@nickvergessen this features are now finished and in a usable state, I tested it manually since tests are still missing, scheduled deletion and scheduled announcing works.

Some notes/caveats, do you which for some of these things to be implemented here?:

• Scheduled notifications might need some time, since they need to be first found by the background-scheduler-job, which then starts a queued-background-job (your job) for notifications
• Scheduling is only in the future, but you can set the deletion date in front of the publishing date. This is partially mitigated, because announcements won't be deleted, if they are not published. However, this could be, with some extra time, implemented, by checking the selected announcement time. But this would still not work, if you select the deletion time first, then you would need to check the selected deletion time and prevent the announcement time to be set after it.
• While this doesn't implement an archive, the same background job could check for very old (configurable) announcements and "archive them" (whatever this means)
• Yet to be announced announcements can't be changed in time or directly published with a button. The workaround is to delete the announcement and redo it with the right date or publish it immediatly
• Yet to be deleted annoucements the same, see above
• Announcements without deletion date can't add one, but can ofc. be directly deleted

Next thing on my list is to add tests and call it a day

[mwinkens]

Waiting for feedback 🥳

[nickvergessen]

Some minor comments, nothing really blocking, but didn't have the time to test it yet.

[mwinkens]

Hello @nickvergessen, are you okay with these changes?

[nickvergessen]

Sorry, I'm heavily overloaded atm.
I hope I find the time soon to have a look.

[nickvergessen]

groups is not registered here, it's string on the database?

[mwinkens]

Yes, it has to be, because when the announcement will be, well, announced in the future, it needs to notifiy the groups, so they need to be stored somewhere

[nickvergessen]

yeah I more meant to register all fields, even if they have the "default" type

[nickvergessen]

most likely we should have an index on both time columns as we select by them?

[mwinkens]

I unfortunately don't know how to do this 🤔

[nickvergessen]

Yeah no problem for now.

[nickvergessen]

you want to change to that? I think it'd be better

[mwinkens]

you want to change to that? I think it'd be better

Maybe we should use https://www.php.net/manual/en/function.json-encode.php here, what do you think @nickvergessen ?

[nickvergessen]

Maybe we should use https://www.php.net/manual/en/function.json-encode.php here, what do you think

I'd appriciate this to avoid any possibility to break with "strange" characters in group names

[nickvergessen]

So just to summarize, my proposal would be:

• Migrate to json_encode()/json_decode() for the group handling
• Make sure only posting or schedule time is shown
• Revert package* changes if nothing new is required there
• Check what 'BUG:' in src/Components/Announcement.vue is about

Raise issues for follow ups:

• Move scheduling and deletion to … menu

And then we can merge this and include it in the next RC which I need to publish for 30 compatibility first half of next week

[mwinkens]

@nickvergessen I finished everything on your list and opened an issue for the followup. I also reset the package files, however I'd like you to know, that for the next release I'd upgrade the packages: 10 vulnerabilities (5 moderate, 5 critical) from npm

[nickvergessen]

new Date(null).getTime()
0 

So you are never sending null.
But also just a detail as in the Controller and Manager null and 0 are treated the same.