Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump deliciousbrains/wp-background-processing from 1.3.1 to 1.4.0 #788

Open
wants to merge 1 commit into
base: latest
Choose a base branch
from

Conversation

dependabot[bot]
Copy link

@dependabot dependabot bot commented on behalf of github Dec 23, 2024

Bumps deliciousbrains/wp-background-processing from 1.3.1 to 1.4.0.

Release notes

Sourced from deliciousbrains/wp-background-processing's releases.

1.4.0

What's Changed

Full Changelog: deliciousbrains/wp-background-processing@1.3.1...1.4.0


Chain ID

A Chain ID has been introduced that is automatically generated for each unique chain of background processes.

The Chain ID is a UUIDv4.

The Chain ID is carried across from one dispatched background process to its successor via a simple URL param in order to be as compatible as possible.

To avoid any potential WAF rules that might take offence to a chain_id param in the URL, the default chain_id param name can be altered via a {identifier}_chain_id_arg_name filter.

The Chain ID is exposed to interested parties in a number of ways to allow users of the library to monitor and control the lifecycle of background processes, e.g. to ensure that only one process chain is running.

There is now a {identifier}_pre_dispatch filter that is fired before dispatch which can be used to cancel a dispatch before it happens by returning true (for cancel). The 2nd param to the new filter is the chain_id.

The existing {identifier}_paused/resumed/cancelled/completed actions now include the chain_id as a param.

Similarly, the {identifier}_process_locked and {identifier}_process_unlocked actions now include the chain_id as a param.

Port-forwarded Improvements

Various other improvements have been port-forwarded from use in our plugins.

  • A new get_status function that works around issues with the options cache exists and is used by is_paused and is_cancelled.
  • The lock_process function now takes an optional $reset_start_time param that is true by default. This is useful when you wish to refresh the lock transient to keep it alive longer without changing the start time held in the record that may be significant to a calculation.
  • A public should_continue function has been added that wraps the checks of batch limits or status change requests that mean no further processing of the task should continue.
  • A public get_identifier function has been added to make it easier to create hooks in plugins that use the library and validate that the process is of interest.
Commits
  • 7ca7cc3 Merge pull request #124 from deliciousbrains/spike/bg-process-uuid
  • b9d5c6e Add chain_id param to paused/resumed/cancelled/completed actions
  • 79ef1ff Improve robustness of WP_Background_Process::get_chain_id
  • 0da8e73 Ensure .phpunit.result.cache is removed with clean Makefile target
  • 8444cda Add chain_id to help identify unique background process chains
  • b48f5af Ensure WP_Background_Process:maybe_handle checks referrer early
  • d51a9fa Add and use WP_Background_Process::get_status function
  • 6ae6bd1 Fix comments in WP_Async_Request
  • 212b8ea Merge pull request #117 from deliciousbrains/codeowners-proj-key
  • f7c6744 Updated CODEOWNERS to use jira key
  • See full diff in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [deliciousbrains/wp-background-processing](https://github.com/deliciousbrains/wp-background-processing) from 1.3.1 to 1.4.0.
- [Release notes](https://github.com/deliciousbrains/wp-background-processing/releases)
- [Commits](deliciousbrains/wp-background-processing@1.3.1...1.4.0)

---
updated-dependencies:
- dependency-name: deliciousbrains/wp-background-processing
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file php Pull requests that update Php code labels Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file php Pull requests that update Php code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants