Add event reminder (=self announcing of event at a specified time gap before the event starts) #58

Open

linos wants to merge 9 commits from self_announce into main

pull from: self_announce

merge into: Event-Federation:main

Event-Federation:main

Event-Federation:event_sources

Event-Federation:plugin_review

Event-Federation:custom_summary

Event-Federation:rename

Event-Federation:event-post

Event-Federation:php-84

Event-Federation:event-organiser

Event-Federation:eventprime

Event-Federation:fix-transformer-hook

Event-Federation:join_ignore

Event-Federation:improve_admin_Ui

Event-Federation:mycalendar-init

Event-Federation:wp_org_fix

Event-Federation:refactor_locations

Event-Federation:wordpress-org

Event-Federation:php74

Event-Federation:prepare_first_release

Event-Federation:readme_improvements

Event-Federation:improve_admin_help

Event-Federation:gp_improvements

Event-Federation:status_page

Event-Federation:improve_mec

Event-Federation:mec

Event-Federation:improve_readme

Event-Federation:eventin

Event-Federation:improve_doc

Event-Federation:wp_events_manager

Event-Federation:fix_duplicated_event_cat

Event-Federation:ci_badge

Event-Federation:rename_plugin

Event-Federation:improve_tribe_transformer

Event-Federation:improve_tribe

Event-Federation:transformer_refactoring

Event-Federation:timezones

Event-Federation:cleanup_file_tops

Event-Federation:plugin_doc

Event-Federation:tribe_improvements

Event-Federation:fix_tribe_location

Event-Federation:format_summary

Event-Federation:ci_multiple_integrations

Event-Federation:improve_tests

Event-Federation:ci_mobilizon

Event-Federation:ci_gancio

Event-Federation:cleanup

Event-Federation:improve_actions

Event-Federation:forgejo_runner

Event-Federation:woodpecker

Event-Federation:transformer_improvments_2

Event-Federation:class_plugin_adapter

Event-Federation:setup_wizard

Event-Federation:transformer_improvements

Event-Federation:setting_mapping

Event-Federation:dev

Event-Federation:category_mapping

Event-Federation:settings

Event-Federation:admin_notices

Event-Federation:refactoring

Event-Federation:generic-event-transformer

Event-Federation:gatherpress

Event-Federation:documentation

Conversation 0 Commits 9 Files changed 22 +567 -13

linos commented 2024-10-11 10:59:45 +02:00

Owner

Copy link

Note

This is currently not merged until upstream issue (https://github.com/Automattic/wordpress-activitypub/issues/938) is solved.
Re-implenting the scheduling off the announce logic would lead to a lot of duplicated code, it would be possible, but it is much cleaner to just wait for upstream to provide a better API for scheduling ActivityPub activities.

This pull requests adds a feature which allows sending reminders that an event is about to start to ActivityPub followers.

How it works:

• It allows for a general setting that controls this behavior for all public events as well as an override per event via an meta field.
• Uses WordPress schedules to schedule a single event when the reminder will be send.
• Currently it only sends an Announce of the Event itself.
• For simplicity and straightforwardness in the UI there are currently the following choices: Disables, 6 hours, 1 day, 3 days, 1 week.

Screenshots

To do:

• Documenting the code.
• Documenting this feature in the Readme (Event-Federation/wordpress-activitypub-event-bridge#65)
• Upstream issue (https://github.com/Automattic/wordpress-activitypub/issues/938)
• Write tests

Further thoughts:
Sending an announce of an ActivityPub object that has already been shared via a create works well for some platforms but not that well for others. Whether the boost shows up in a Mastodon timeline, is highly depending on which app someone is using as well as the way the target ActivityPub software handles not showing the same object twice within a time frame.

Another more strict way of making sure the event shows up in the timeline of followers again would be sending a automatically composed note that links to the event, but this is not in the scope of the pull request.

> **Note** > This is currently not merged until upstream issue (https://github.com/Automattic/wordpress-activitypub/issues/938) is solved. > Re-implenting the scheduling off the announce logic would lead to a lot of duplicated code, it would be possible, but it is much cleaner to just wait for upstream to provide a better API for scheduling ActivityPub activities. This pull requests adds a feature which allows sending reminders that an event is about to start to ActivityPub followers. **How it works:** - It allows for a general setting that controls this behavior for all public events as well as an override per event via an meta field. - Uses WordPress schedules to schedule a single event when the reminder will be send. - Currently it only sends an Announce of the Event itself. - For simplicity and straightforwardness in the UI there are currently the following choices: Disables, 6 hours, 1 day, 3 days, 1 week. **Screenshots**   **To do:** - [x] Documenting the code. - [x] Documenting this feature in the Readme (https://code.event-federation.eu/Event-Federation/wordpress-activitypub-event-bridge/pulls/65) - [ ] Upstream issue (https://github.com/Automattic/wordpress-activitypub/issues/938) - [x] Write tests **Further thoughts:** Sending an announce of an ActivityPub object that has already been shared via a create works well for some platforms but not that well for others. Whether the boost shows up in a Mastodon timeline, is highly depending on which app someone is using as well as the way the target ActivityPub software handles not showing the same object twice within a time frame. Another more strict way of making sure the event shows up in the timeline of followers again would be sending a automatically composed note that links to the event, but this is not in the scope of the pull request.

image.png

22 KiB

image.png

23 KiB

linos added the

Mandatory

label 2024-10-11 10:59:45 +02:00

linos self-assigned this 2024-10-11 10:59:45 +02:00

linos added 1 commit 2024-10-11 10:59:45 +02:00

first draft for event reminders 92fc3ecec0

linos added this to the 3. Beta State project 2024-10-11 10:59:45 +02:00

linos added this to the Feature: Send reminders milestone 2024-10-11 11:09:25 +02:00

linos added 1 commit 2024-10-11 19:05:25 +02:00

add tests 63bf5d26ce

linos added 1 commit 2024-10-11 19:07:10 +02:00

phpcs 2d902806ee

linos added 1 commit 2024-10-11 19:20:51 +02:00

exclude js from phpcs d5dcfd5e0c

linos added 1 commit 2024-10-11 19:27:15 +02:00

fix phpcs 4263233e10

linos added 1 commit 2024-10-11 19:31:00 +02:00

Merge branch 'main' into self_announce ecb6fce8bc

linos added 1 commit 2024-10-12 09:42:30 +02:00

use builds not dev js d7a5b140ec

linos added 1 commit 2024-10-13 15:23:11 +02:00

Merge branch 'main' into self_announce 670b9aec50

linos added 1 commit 2024-10-13 15:39:28 +02:00

improve docs and readability 1bb603331a

linos changed title from WIP: add event reminder (=self announcing of event at a specified time gap before the event starts) to Add event reminder (=self announcing of event at a specified time gap before the event starts) 2024-10-13 16:03:46 +02:00

All checks were successful

Hide all checks

PHP Code Checker / PHP Code Checker (pull_request) Successful in 34s

Details

PHPUnit / PHPUnit – PHP 8.1 (pull_request) Successful in 1m3s

Details

PHPUnit / PHPUnit – PHP 8.2 (pull_request) Successful in 1m3s

Details

PHPUnit / PHPUnit – PHP 8.3 (pull_request) Successful in 1m2s

Details

This pull request has changes conflicting with the target branch.

• composer.json
• includes/class-settings.php
• includes/class-setup.php
• includes/plugins/class-event-plugin.php
• package.json
• templates/settings.php
• tests/bootstrap.php

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin self_announce:self_announce

git checkout self_announce

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git checkout main

git merge --no-ff self_announce

git checkout self_announce

git rebase main

git checkout main

git merge --ff-only self_announce

git checkout self_announce

git rebase main

git checkout main

git merge --no-ff self_announce

git checkout main

git merge --squash self_announce

git checkout main

git merge --ff-only self_announce

git checkout main

git merge self_announce

git push origin main

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels   

Community

  

Enhancement

New feature

  

Mandatory

This has to be priorized

  

bug

Something is not working

  

duplicate

This issue or pull request already exists

  

help wanted

Need some help

  

invalid

Something is wrong

  

question

More information is needed

  

wontfix

This won't be fixed

No labels

Community

Enhancement

Mandatory

bug

duplicate

help wanted

invalid

question

wontfix

Milestone

Clear milestone

No items

No milestone

Feature: Send reminders

Projects

Clear projects

No items

No project

3. Beta State

Assignees

Clear assignees

No assignees

linos

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Event-Federation/wordpress-event-bridge-for-activitypub#58

No description provided.