Should we be using any additional indexes on our custom tables?

WordPress Tasks Module

A task system for processing asynchronous tasks with wordpress, the tasks could be one-off long running tasks or periodic tasks.

Module Responsibilities

Define structures for both one-off and periodic tasks, including necessary parameters such as priority and task type.
Maintain a queue of pending tasks in database.
Provide interfaces for adding, updating, and removing tasks.
Handle task prioritization to ensure that tasks are executed in the order of their priority.
Implement scheduling mechanisms for both one-off and periodic tasks, ensuring timely execution according to predefined schedules.
Execute one-off and periodic tasks asynchronously in the background, allowing the system to continue processing tasks without blocking.
Remove completed tasks from the system after execution to maintain efficiency and prevent unnecessary resource usage.

Critical Paths

When a one-off or periodic task is scheduled, the scheduler component is responsible for picking up tasks based on their priority.
The scheduler initiates the execution of tasks, ensuring that they are processed in the correct order.
If a task fails during execution, the scheduler handles retries according to predefined policies, ensuring that tasks are eventually completed successfully.

Installation

1. Add the Newfold Satis to your `composer.json`.

composer config repositories.newfold composer https://newfold-labs.github.io/satis

2. Require the `newfold-labs/wp-module-tasks` package.

composer require newfold-labs/wp-module-tasks

Tasks

The system intends to support one-off and periodic tasks.
One-off tasks will be the long running tasks which will be executed by the system in background in an asynchronous manner, these tasks will be picked up according to the priority assigned to them, results will be recorded and then the tasks will subsequently be removed from the system, i.e. we will not be tracking these tasks again unless they are inserted back with other parameters. Some examples of tasks like these could be packaging wordpress related items, sending emails, installing a plugin, updating a plugin, bulk installs, bulk updates etc.

Setting up the module

In order for the module to work, we'd need tables for storing the tasks queue and the task results, please use the following functions in order to automatically create / delete the tables while activating and deactivating the plugin.

register_activation_hook( __FILE__, 'nfd_tasks_setup_tables' );
register_deactivation_hook( __FILE__, 'nfd_tasks_purge_tables' );

Adding a one-off task.

After you include the module as a dependency in your plugin, you can then schedule a one-off task for a function foo to be run as below:

use NewfoldLabs\WP\Module\Tasks\Models\Task;

function foo( $args ) {
    // do something.
}
$task = new Task();
// or use any loaded function like \Class::static_func etc.
$task->set_task_name('hello')
    ->set_task_execute('foo')
    ->set_num_retries(2)
    ->set_args( $args )
    ->set_priority( 10 );
// Queue the task by
$task->queue_task();

The scheduler will take up tasks based on the task priority and take care of retries in case the task fails. The scheduler will also be responsible for recording the results for the task runs in a db called wp_task_results.

Adding a periodic task.

The installation and including of the module works the same as in the case of one-off tasks, we can add periodic tasks very similar to how we add a one-off task, only difference is in the parameters we pass while creating that module like so:

use NewfoldLabs\WP\Module\Tasks\Models\Task;

function foo( $args ) {
    // do something.
}

$task = new Task();
$task->set_name('foo_task')
    ->set_task_execute('foo')
    ->set_args( $args )
    ->set_interval(30)
$task->queue_task();

Caveats

You can not be sure of the time when the one-off tasks will execute, since the system depends on wp-cron and which in turn depends on page loads, the tasks will not run unless there are enough page loads.

PS: It is possible to simulate page loads with a request to /wp-cron.php, and hook this request with an actual cron to ensure that the tasks keep running when required

Refer: https://developer.wordpress.org/plugins/cron/hooking-wp-cron-into-the-system-task-scheduler/ for more.

	$id = null,
	$task_name = null,
	$task_executor_path = null,
	$task_execute = null,
	$args = null,
	$num_retries = 0,
	$task_interval = null,
	$task_priority = null,
	$enabled = true

	public static function setup() {
	global $wpdb;
	$table_name = MODULE_TASKS_TASK_TABLE_NAME;

	// Maybe create the table
	if ( ! function_exists( 'maybe_create_table' ) ) {
	require_once ABSPATH . 'wp-admin/includes/upgrade.php';
	}

	$charset_collate = $wpdb->get_charset_collate();
	$sql = "CREATE TABLE `{$wpdb->prefix}{$table_name}` (
	task_id bigint(20) NOT NULL AUTO_INCREMENT,
	task_name varchar(63) NOT NULL,
	task_executor_path varchar(125),
	task_execute varchar(125),
	args longtext,
	num_retries int(2) UNSIGNED,
	task_interval int(2) UNSIGNED,
	task_priority int(2) UNSIGNED,
	task_status varchar(12),
	updated TIMESTAMP NOT NULL ON UPDATE CURRENT_TIMESTAMP,
	enabled tinyint(1),
	PRIMARY KEY (task_id)
	) $charset_collate;";

	maybe_create_table( $wpdb->prefix . $table_name, $sql );
	}

	public static function setup() {
	global $wpdb;
	$table_name = MODULE_TASKS_TASK_RESULTS_TABLE_NAME;

	// Maybe create the table
	if ( ! function_exists( 'maybe_create_table' ) ) {
	require_once ABSPATH . 'wp-admin/includes/upgrade.php';
	}

	$charset_collate = $wpdb->get_charset_collate();
	$sql = "CREATE TABLE `{$wpdb->prefix}{$table_name}` (
	task_result_id bigint(20) NOT NULL AUTO_INCREMENT,
	task_id bigint(20) NOT NULL,
	task_name varchar(63) NOT NULL,
	stacktrace longtext,
	success tinyint(1),
	updated TIMESTAMP NOT NULL ON UPDATE CURRENT_TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
	PRIMARY KEY (task_result_id)
	) $charset_collate;";

	maybe_create_table( $wpdb->prefix . $table_name, $sql );
	}

	/**
	* Add a 20 seconds interval
	*
	* @param array $schedules The existing interval schedules
	*/
	public function add_interval_schedule( $schedules ) {
	// Adds the schedule for the given intervals in seconds
	if ( ! array_key_exists( 'twenty_seconds', $schedules ) \|\| 20 !== $schedules[ 'twenty_seconds' ]['interval'] ) {
	$schedules[ 'twenty_seconds' ] = array(
	'interval' => 20,
	'display' => __( 'Cron to run once every twenty seconds' ),
	);
	}

	// Adds the schedule for the given intervals in seconds
	if ( ! array_key_exists( 'ten_minutes', $schedules ) \|\| 600 !== $schedules[ 'ten_minutes' ]['interval'] ) {
	$schedules[ 'ten_minutes' ] = array(
	'interval' => 600,
	'display' => __( 'Cron to run once every ten minutes' ),
	);
	}

	return $schedules;
	}

newfold-labs / wp-module-tasks Goto Github PK

wp-module-tasks's Introduction

WordPress Tasks Module

Module Responsibilities

Critical Paths

Installation

1. Add the Newfold Satis to your composer.json.

2. Require the newfold-labs/wp-module-tasks package.

Tasks

Setting up the module

Adding a one-off task.

Adding a periodic task.

Caveats

wp-module-tasks's People

Contributors

Stargazers

Watchers

wp-module-tasks's Issues

Recommend Projects

Recommend Topics

Recommend Org

1. Add the Newfold Satis to your `composer.json`.

2. Require the `newfold-labs/wp-module-tasks` package.