├── .editorconfig
├── .github
└── workflows
│ ├── composer-diff.yml
│ └── php.yml
├── .gitignore
├── .phpcs.xml.dist
├── .travis.yml
├── CHANGELOG.md
├── Dockerfile
├── LICENSE
├── README.md
├── cghooks.lock
├── composer.json
├── composer.lock
├── phpunit.xml.dist
├── plugin.php
├── src
├── CLI
│ └── Commands.php
├── Dequeuer.php
├── Enqueuer.php
├── Entry.php
├── Exception
│ ├── QueueContainerException.php
│ └── QueueNotFoundException.php
├── Instance
│ ├── Base.php
│ └── RedisQueue.php
├── Interfaces
│ ├── EntryFetcherInterface.php
│ ├── EntryHandlerInterface.php
│ ├── EntryInterface.php
│ └── QueueInterface.php
├── Logger.php
├── Mock
│ ├── MockEntryFetcher.php
│ ├── MockEntryHandler.php
│ └── MockQueue.php
├── QueueContainer.php
├── QueueCreator.php
├── QueuePlugin.php
└── functions.php
└── tests
├── TestDequeuer.php
├── TestEnqueuer.php
├── TestFunctions.php
├── TestQueueContainer.php
├── TestQueueCreator.php
├── TestRedisQueue.php
└── bootstrap.php
/.editorconfig:
--------------------------------------------------------------------------------
1 | root = true
2 |
3 | [*]
4 | charset = utf-8
5 | end_of_line = lf
6 | indent_size = 4
7 | indent_style = space
8 | insert_final_newline = true
9 | max_line_length = 160
10 | tab_width = 4
11 | trim_trailing_whitespace = true
12 |
13 | [*.php]
14 | max_line_length = 120
15 |
--------------------------------------------------------------------------------
/.github/workflows/composer-diff.yml:
--------------------------------------------------------------------------------
1 | name: Composer Diff
2 | on:
3 | pull_request:
4 | paths:
5 | - 'composer.lock'
6 | jobs:
7 | composer-diff:
8 | name: Composer Diff
9 | runs-on: ubuntu-latest
10 | steps:
11 | - name: Checkout
12 | uses: actions/checkout@v2
13 | with:
14 | fetch-depth: 0 # Required to make it possible to compare with PR base branch
15 |
16 | - name: Generate composer diff
17 | id: composer_diff # To reference the output in comment
18 | uses: IonBazan/composer-diff-action@v1
19 |
20 | - uses: marocchino/sticky-pull-request-comment@v2
21 | with:
22 | header: composer-diff # Creates a collapsed comment with the report
23 | message: |
24 |
25 | Composer package changes
26 |
27 | ${{ steps.composer_diff.outputs.composer_diff }}
28 |
29 |
30 |
--------------------------------------------------------------------------------
/.github/workflows/php.yml:
--------------------------------------------------------------------------------
1 | name: PHP Composer
2 |
3 | on:
4 | push:
5 | branches: [ master ]
6 | pull_request:
7 | branches: [ master ]
8 |
9 | jobs:
10 | build:
11 | runs-on: ubuntu-latest
12 |
13 | strategy:
14 | fail-fast: true
15 | matrix:
16 | php: [ '7.4', '8.0', '8.1' ]
17 | stability: [ prefer-stable ]
18 | include:
19 | - php: '7.4'
20 | composer: '1'
21 | - php: '8.0'
22 | composer: '2'
23 | - php: '8.1'
24 | composer: '2'
25 |
26 | name: PHP ${{ matrix.php }} - ${{ matrix.stability }}
27 |
28 | steps:
29 | - name: Checkout code
30 | uses: actions/checkout@v2
31 |
32 | - name: Setup PHP
33 | uses: shivammathur/setup-php@v2
34 | with:
35 | php-version: ${{ matrix.php }}
36 | tools: composer:${{ matrix.composer }}
37 | coverage: none
38 |
39 | - name: Validate composer.json and composer.lock
40 | run: composer validate --strict
41 |
42 | - name: Get composer cache directory
43 | id: composer-cache
44 | run: echo "::set-output name=dir::$(composer config cache-files-dir)"
45 |
46 | - name: Cache dependencies
47 | uses: actions/cache@v2
48 | with:
49 | path: ${{ steps.composer-cache.outputs.dir }}
50 | key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}-${{ matrix.prefer }}-
51 | restore-keys: ${{ runner.os }}-composer-${{ matrix.prefer }}-
52 |
53 | - name: Install dependencies
54 | uses: nick-invision/retry@v1
55 | with:
56 | timeout_minutes: 5
57 | max_attempts: 5
58 | command: composer update --${{ matrix.stability }} --prefer-dist --no-interaction --no-progress
59 |
60 | - name: Run test suite
61 | run: composer test
62 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Ignore node dependency directories
2 | node_modules/
3 |
4 | # Ignore composer vendor packages.
5 | vendor/
6 |
7 | # Ignore log files and databases
8 | *.log
9 | *.sql
10 | *.sqlite
11 |
12 | # Ignore editor configs.
13 | .idea
14 |
15 | # Ignore PHPUnit cache.
16 | .phpunit.result.cache
--------------------------------------------------------------------------------
/.phpcs.xml.dist:
--------------------------------------------------------------------------------
1 |
2 |
3 | Generally-applicable sniffs for WordPress plugins.
4 |
5 |
6 | .
7 | /vendor/
8 | /node_modules/
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: php
2 |
3 | notifications:
4 | slack:
5 | if: (branch = master) OR (branch =~ /^(release).*$/)
6 | on_success: always
7 | on_failure: always
8 |
9 | php:
10 | - nightly
11 | - 8.0
12 | - 7.4
13 |
14 | jobs:
15 | allow_failures:
16 | - php: nightly
17 |
18 | install:
19 | - rm composer.lock
20 | - travis_retry composer update --no-interaction --prefer-dist --no-suggest --no-progress
21 |
22 | script:
23 | - composer test
24 |
25 | cache:
26 | directories:
27 | - $HOME/.composer/cache
28 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Changelog
2 |
3 | All notable changes to this project will be documented in this file.
4 |
5 | The format is based on [Keep a Changelog][keepachangelog] and this project adheres to [Semantic Versioning][semver].
6 |
7 | ## [Unreleased]
8 |
9 | ## [Released]
10 |
11 | ## [1.0.1] - 2023-02-01
12 |
13 | ### Changed
14 | - Fix declaration compatible with Psr\Container\ContainerInterface fatal errors after PHP 8.1 upgrade.
15 |
16 | ### Changed
17 |
18 | - Enable PHP8, fixes tests, adds github workflows... #6
19 |
20 | ## [1.0.0] - 2020-08-27
21 |
22 | ### Changed
23 |
24 | - Lots of refactoring and structure changes.
25 |
26 | ### Added
27 |
28 | - Tests.
29 |
30 | ### Added
31 |
32 | - feature/entry-exists: Method for checking if entry exists in queue added to RedisQueue.
33 |
34 | [keepachangelog]: http://keepachangelog.com/en/1.0.0/
35 | [semver]: http://semver.org/spec/v2.0.0.html
36 |
--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM php:7.4-cli
2 |
3 | MAINTAINER devgeniem
4 |
5 | RUN apt-get update
6 | RUN apt-get install -y python-pip
7 | RUN pip install -U pip
8 | RUN pip install pywatch
9 |
10 | WORKDIR /opt
11 |
12 | ENTRYPOINT ["pywatch"]
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | {project} Copyright (C) {year} {fullname}
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 |
3 | # WordPress Queue
4 |
5 | [](https://travis-ci.org/devgeniem/wp-queue) [](https://packagist.org/packages/devgeniem/wp-queue) [](https://packagist.org/packages/devgeniem/wp-queue) [](https://packagist.org/packages/devgeniem/wp-queue) [](https://packagist.org/packages/devgeniem/wp-queue)
6 |
7 | WordPress Queue is a modular library for managing queued tasks in WordPress.
8 |
9 | ## Installation
10 |
11 | Install with Composer:
12 |
13 | ```
14 | composer config repositories.wp-queue git git@github.com:devgeniem/wp-queue.git
15 | composer require devgeniem/wp-queue
16 | ```
17 |
18 | The plugin initializes itself in the `plugins_loaded` hook. Your code should start using the plugin features after this hook is run by WordPress. An alternative is to customize the plugin initialization hook with the provided filter `wqp_init_hook`. See [plugin.php](./plugin.php) for details.
19 |
20 | ## Functionalities
21 |
22 | ### Queue structure
23 |
24 | A queue consists of its name, an entry handler and some entries. Entries are statically typed objects holding the data. An entry handler is the controller called when dequeueing a single entry. The name is used to identify the queue, for instance, with WP-CLI.
25 |
26 | Queue functionalities are defined with the `\Geniem\Queue\Interfaces\QueueInterface` interface. You can create your own queue controller by implementing this interface. We provide an abstract class, `Geniem\Queue\Instance\Base`, that you can extend as a starting point.
27 |
28 | ### Queue creation
29 |
30 | To create a queue, call the implementation constructor with your unique name for the queue. To let WordPress Queue to know about your queue, pass it to the queue container via the `wpq_add_queue` hook. The queue container implements the [PSR-11](https://www.php-fig.org/psr/psr-11/) container interface.
31 |
32 | Here is an example of creating a Redis queue:
33 |
34 | ```php
35 | add_action( 'wpq_add_queue', function( \Psr\Container\ContainerInterface $container ) {
36 | $my_queue = new Geniem\Queue\Instance\RedisQueue( 'my_queue' );
37 | // ...
38 | $container->add( $my_queue );
39 | }, 1, 1 );
40 | ```
41 |
42 | When creating a new queue, all its entries should be stored in the protected `$entries` property as an instance of a class implementing the `\Geniem\Queue\Interfaces\EntryInterface`. The actual entry data is untyped, but we encourage keeping the type consistent withing a specific queue. The actual entry handler can be created by implementing the `\Geniem\Queue\Interfaces\EntryFetcherInterface` interface.
43 |
44 | The queue creation is handled with the `Geniem\Queue\QueueCreator` class. This ensures all dependecies are strictly typed and injected in place.
45 |
46 | ### Accessing a queue
47 |
48 | To interact manually with your previously created queue, you can access it through the plugin's queue container. To access the plugin, you can use the global helper function `wpq()`. It returns the plugin singleton.
49 |
50 | ```php
51 | $my_queue = wpq()->get_queue_container()->get( 'my_queue' );
52 | ```
53 |
54 | ### Entry handling
55 |
56 | A queue consists of a list of entries implementing the `\Geniem\Queue\Interfaces\EntryInterface` interface. WordPress Queue is agnostic about the handling of entries. It is left for you to implement. The dequeuer uses a try-catch block around calling the handle method. Thus, your handler should throw errors if the handling process fails. This enables logging errors and deciding whether to proceed with the dequeue or to rollback to the previous state in the queue. Here is an example of a simple handler that just logs the data in the queue.
57 |
58 | ```php
59 | class MyHandler implements \Geniem\Queue\Interfaces\EntryHandlerInterface {
60 |
61 | public function handle( \Geniem\Queue\Interfaces\EntryInterface $entry ) {
62 | error_log( 'Entry data: ' . $entry->get_data() );
63 | }
64 |
65 | }
66 | ```
67 |
68 | After creating the handler, pass an instance to your queue:
69 |
70 | ```php
71 | add_action( 'wpq_add_queue', function( \Psr\Container\ContainerInterface $container ) {
72 | $my_queue = new Geniem\Queue\Instance\RedisQueue( 'my_queue' );
73 |
74 | // Set the handler.
75 | $my_queue->set_entry_handler( new Myhandler() );
76 |
77 | $container->add( $my_queue );
78 | }, 1, 1 );
79 | ```
80 |
81 | ### Entry fetching and enqueueing
82 |
83 | WordPress Queue introduces a concept of a 'fetcher'. A fetcher is an instance with a functionality of fetching more entries for a queue. Fetchers should implement the `\Geniem\Queue\Interfaces\EntryFetcherInterface` interface. One example of using a fetcher is to integrate your queue to an external API providing some data to be passed to the queue.
84 |
85 | The `Geniem\Queue\Enqueuer` class calls the fetcher's fetch method and wraps the resulting array items into entry objects if not already wrapped. After this, each entry is run through the `enqueue` method of the given queue instance.
86 |
87 | Here is a simple fetcher example always returning the same array of entries.
88 |
89 | ```php
90 | class MyFetcher implements \Geniem\Queue\Interfaces\EntryFetcherInterface {
91 |
92 | public function fetch() : ?array {
93 | $entry_data = [
94 | 'Item 1',
95 | 'Item 2',
96 | 'Item 3',
97 | 'Item 4',
98 | ];
99 |
100 | return $entries;
101 | }
102 |
103 | }
104 | ```
105 |
106 | And then, adding an fetcher instance for your queue:
107 |
108 | ```php
109 | add_action( 'wpq_add_queue', function( \Psr\Container\ContainerInterface $container ) {
110 | $my_queue = new Geniem\Queue\Instance\RedisQueue( 'my_queue' );
111 |
112 | // Set the fetcher.
113 | $my_queue->set_entry_fetcher( new MyFetcher() );
114 |
115 | $container->add( $my_queue );
116 | }, 1, 1 );
117 | ```
118 |
119 | The fetching process is run with the `Geniem\Queue\Enqueuer`. You can run it with the WP-CLI command or if you want to do it manually in PHP, run the following:
120 |
121 | ```
122 | $enqueuer = new \Geniem\Queue\Enqueuer();
123 | $enqueuer->fetch( $my_queue );
124 | ```
125 |
126 | To enqueue a single entry, call the `enqueue` method and pass an entry:
127 |
128 | ```
129 | $entry = ( new \Geniem\Queue\Entry() )->set_data( 'Just a string' );
130 | $enqueuer = new \Geniem\Queue\Dequeuer();
131 | $enqueuer->enqueue( $my_queue, $entry );
132 | ```
133 |
134 | _Note! You can call the enqueue method directly from your queue instance, but we recommend using the enqueuer for generalized error handling and logging._
135 |
136 | ### Dequeueing
137 |
138 | A dequeue process handles the first entry in a queue. If the handing is successful, the entry is popped out from the queue. Note that the final implementation of the queue processsing is dependant of the queue class.
139 |
140 | The dequeue process is handled by the `Geniem\Queue\Dequeuer`. When using the WP-CLI commands, this is done automatically. If you want to manually run the dequeu, do the following:
141 |
142 | ```
143 | $dequeuer = new \Geniem\Queue\Dequeuer();
144 | $dequeuer->dequeue( $my_queue );
145 | ```
146 |
147 | _Note! You can call the dequeue method directly from your queue instance, but we recommend using the dequeuer for generalized error handling and logging._
148 |
149 | ## Example
150 |
151 | In the following examples we create a simple fetcher returning an array of entries containing a simple string in the data. Then finally the handler just logs the data into PHP error log. The whole process is completed with creating a Redis queue. After this, the queue is accessible through WP-CLI.
152 |
153 | #### Fetcher example
154 |
155 | ```php
156 | class MyFetcher implements \Geniem\Queue\Interfaces\EntryFetcherInterface {
157 |
158 | public function fetch() : ?array {
159 | $entry_data = [
160 | 'Item 1',
161 | 'Item 2',
162 | 'Item 3',
163 | 'Item 4',
164 | ];
165 |
166 | $entries = array_map( function( $data ) {
167 | $entry = new \Geniem\Queue\Entry();
168 | $entry->set_data( $data );
169 | return $entry;
170 | }, $entry_data );
171 |
172 | return $entries;
173 | }
174 |
175 | }
176 | ```
177 |
178 | #### Handler example
179 |
180 | ```php
181 | class MyHandler implements \Geniem\Queue\Interfaces\EntryHandlerInterface {
182 |
183 | public function handle( \Geniem\Queue\Interfaces\EntryInterface $entry ) {
184 | error_log( 'Entry data: ' . $entry->get_data() );
185 | }
186 |
187 | }
188 | ```
189 |
190 | ### Usage example
191 |
192 | To allow WordPress Queue to find our example queue by its name "my_queue", we must define it by adding it to the queue container in the `wpq_add_queue` hook. Here we use the default RedisQueue as our queue instance. To add a new queue into the container call the `add` method. To replace an existing one with the same name, call the `replace` method.
193 |
194 | ```php
195 | add_action( 'wpq_add_queue', function( \Psr\Container\ContainerInterface $container ) {
196 | $redis_queue = new Geniem\Queue\Instance\RedisQueue( 'my_queue' );
197 | $redis_queue->set_entry_fetcher( new MyFetcher() );
198 | $redis_queue->set_entry_handler( new MyHandler() );
199 |
200 | $container->add( $redis_queue );
201 | }, 1, 1 );
202 | ```
203 |
204 | ## WP-CLI commands
205 |
206 | After the queue has been instantiated and added to the queue container, you can start to interact with it through WP-CLI.
207 |
208 | ### Create
209 |
210 | To create the queue, call the WP-CLI `create` command. This will run the entry fetcher if one is set for the queue and (re)create the queue by saving it with the newly fetched entries.
211 |
212 | ```
213 | wp queue create my_queue
214 | ```
215 |
216 | ### Dequeue
217 |
218 | After creating, you can dequeue a single entry from the queue:
219 |
220 | ```
221 | wp queue dequeue my_queue
222 | ```
223 |
224 | ### Fetch
225 |
226 | To fetch more entries to the queue, run the `fetch` command. This command will try to call the fetcher's `fetch` method and append the found entries to the queue.
227 |
228 | ```
229 | wp queue fetch my_queue
230 | ```
231 |
232 | ## Tests
233 |
234 | The plugin is tested locally with [PHPUnit](https://phpunit.de/) and automatically with the GitHub integration of [Travic CI](https://travis-ci.org/). For local testing we provide a Dockerfile configuration to run PHPUnit inside a Docker container. The container also contains [pywatch](https://pypi.org/project/pywatch/) for watching changes tests and then rerunning them. To start running tests locally, navigate to your plugin directory and follow this process:
235 |
236 | ```
237 | # Install local composer packages.
238 | composer install
239 | # Build and tag the container.
240 | docker build . -t phptest:7.4
241 | # Run the container and watch changes.
242 | docker run --rm -it -v $(pwd):/opt phptest:7.4 "php ./vendor/bin/phpunit" ./tests/*.php
243 | ```
244 |
245 | ## Contributors
246 |
247 | - [Check the up-to-date list here](https://github.com/devgeniem/wp-queue/graphs/contributors)
248 |
--------------------------------------------------------------------------------
/cghooks.lock:
--------------------------------------------------------------------------------
1 | ["pre-commit"]
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "devgeniem/wp-queue",
3 | "type": "wordpress-muplugin",
4 | "description": "WordPress Queue is a modular library for managing queued tasks in WordPress.",
5 | "authors": [
6 | {
7 | "name": "Ville Siltala",
8 | "email": "ville.siltala@geniem.com",
9 | "homepage": "https://geniem.com/",
10 | "role": "Developer"
11 | }
12 | ],
13 | "keywords": [
14 | "wordpress",
15 | "mu-plugin",
16 | "queue",
17 | "background process",
18 | "asynchronous"
19 | ],
20 | "license": "MIT",
21 | "minimum-stability": "stable",
22 | "autoload": {
23 | "psr-4": {
24 | "Geniem\\Queue\\": [
25 | "src/",
26 | "plugin.php"
27 | ]
28 | }
29 | },
30 | "require": {
31 | "php": "^7.4 || ^8.0 || ^8.1",
32 | "psr/log": "^1.1.3",
33 | "psr/container": "^1.1.1"
34 | },
35 | "require-dev": {
36 | "roave/security-advisories": "dev-latest",
37 | "devgeniem/geniem-rules-codesniffer": "^1",
38 | "brainmaestro/composer-git-hooks": "^v2.8.5",
39 | "phpunit/phpunit": "^9",
40 | "10up/wp_mock": "^0.4.2",
41 | "m6web/redis-mock": "^5",
42 | "predis/predis": "2.0.x-dev as 2.0.0.0"
43 | },
44 | "scripts": {
45 | "test": "vendor/bin/phpunit",
46 | "lint": "vendor/bin/phpcs --standard=Geniem plugin.php src/",
47 | "lint-without-warnings": "vendor/bin/phpcs --standard=Geniem plugin.php src/ --warning-severity=8",
48 | "cghooks": "vendor/bin/cghooks"
49 | },
50 | "extra": {
51 | "hooks": {
52 | "pre-commit": [
53 | "composer lint-without-warnings"
54 | ]
55 | }
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/phpunit.xml.dist:
--------------------------------------------------------------------------------
1 |
2 |
10 |
11 |
12 | ./tests/
13 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/plugin.php:
--------------------------------------------------------------------------------
1 | 'Version' ], 'plugin' );
33 | $plugin_version = $plugin_data['Version'];
34 |
35 | $plugin_path = __DIR__;
36 |
37 | QueuePlugin::init( $plugin_version, $plugin_path );
38 | } );
39 |
--------------------------------------------------------------------------------
/src/CLI/Commands.php:
--------------------------------------------------------------------------------
1 | queue_container = $plugin->get_queue_container();
55 | // Get the plugin logger.
56 | $this->logger = $plugin->get_logger();
57 | }
58 |
59 | /**
60 | * Create a queue.
61 | *
62 | * phpcs:disable
63 | *
64 | * ## OPTIONS
65 | *
66 | *
67 | * : The unique queue name.
68 | *
69 | * ## EXAMPLES
70 | *
71 | * # Create a queue with the name 'my_queue'.
72 | * $ wp queue create my_queue
73 | * Success: The queue was created successfully!"
74 | *
75 | * phpcs:enable
76 | *
77 | * @param array $args The command parameters.
78 | * @return boolean
79 | */
80 | public function create( array $args = [] ) : bool {
81 | $queue_name = $args[0] ?? null;
82 |
83 | if ( empty( $queue_name ) ) {
84 | WP_CLI::error( 'Please define the queue name as the first command argument.' );
85 | return false;
86 | }
87 |
88 | /**
89 | * Fetch a queue by name.
90 | *
91 | * @var QueueInterface $queue
92 | */
93 | $queue = $this->queue_container->get( $queue_name );
94 |
95 | if ( ! $queue instanceof QueueInterface ) {
96 | WP_CLI::error( "No queue found with the name \"$queue_name\"." );
97 | return false;
98 | }
99 |
100 | $entry_handler = $queue->get_entry_handler();
101 |
102 | if ( empty( $entry_handler ) ) {
103 | WP_CLI::error(
104 | 'The queue must contain an entry handler before creating the queue.'
105 | );
106 | return false;
107 | }
108 |
109 | try {
110 | $queue_creator = new QueueCreator( $queue );
111 | }
112 | catch ( Exception $err ) {
113 | WP_CLI::error( $err->getMessage() );
114 | return false;
115 | }
116 |
117 | try {
118 | $queue_creator->create();
119 | WP_CLI::success( "The queue \"$queue_name\" was created successfully!" );
120 | return true;
121 | }
122 | catch ( Exception $err ) {
123 | WP_CLI::error( $err->getMessage() );
124 | return false;
125 | }
126 | }
127 |
128 | /**
129 | * Ensure a queue exists.
130 | *
131 | * phpcs:disable
132 | *
133 | * ## OPTIONS
134 | *
135 | *
136 | * : The unique queue name.
137 | *
138 | * ## EXAMPLES
139 | *
140 | * # Ensure a queue exists with the name 'my_queue'.
141 | * $ wp queue ensure my_queue
142 | * Success: The queue exists. No need to recreate it."
143 | *
144 | * phpcs:enable
145 | *
146 | * @param array $args The command parameters.
147 | * @return boolean
148 | */
149 | public function ensure( array $args = [] ) : bool {
150 | $queue_name = $args[0] ?? null;
151 |
152 | if ( empty( $queue_name ) ) {
153 | WP_CLI::error( 'Please define the queue name as the first command argument.' );
154 | return false;
155 | }
156 |
157 | /**
158 | * Fetch a queue by name.
159 | *
160 | * @var QueueInterface $queue
161 | */
162 | $queue = $this->queue_container->get( $queue_name );
163 |
164 | if ( ! $queue instanceof QueueInterface ) {
165 | WP_CLI::error( "No queue found with the name \"$queue_name\"." );
166 | return false;
167 | }
168 |
169 | if ( $queue->exists() ) {
170 | WP_CLI::success( "The queue \"$queue_name\" exists. No need to recreate it." );
171 | return true;
172 | }
173 | else {
174 |
175 | $entry_handler = $queue->get_entry_handler();
176 |
177 | if ( empty( $entry_handler ) ) {
178 | WP_CLI::error(
179 | 'The queue must contain an entry handler before creating the queue.'
180 | );
181 | return false;
182 | }
183 |
184 | try {
185 | $queue_creator = new QueueCreator( $queue );
186 | }
187 | catch ( Exception $err ) {
188 | WP_CLI::error( $err->getMessage() );
189 | return false;
190 | }
191 |
192 | try {
193 | $queue_creator->create();
194 | WP_CLI::success( "The queue \"$queue_name\" was created successfully!" );
195 | return true;
196 | }
197 | catch ( Exception $err ) {
198 | WP_CLI::error( $err->getMessage() );
199 | return false;
200 | }
201 | }
202 | }
203 |
204 | /**
205 | * Delete a queue. All entries are cleared and then the queue data is deleted.
206 | *
207 | * phpcs:disable
208 | *
209 | * ## OPTIONS
210 | *
211 | *
212 | * : The unique queue name.
213 | *
214 | * ## EXAMPLES
215 | *
216 | * # Clear entries and delete all queue data from a queue with the name 'my_queue'.
217 | * $ wp queue delete my_queue
218 | * Success: The queue was deleted succesfully!
219 | *
220 | * phpcs:enable
221 | *
222 | * @param array $args The command parameters.
223 | * @return boolean
224 | */
225 | public function delete( array $args = [] ) : bool {
226 | $queue_name = $args[0] ?? null;
227 |
228 | if ( empty( $queue_name ) ) {
229 | WP_CLI::error( 'Please define the queue name as the first command argument.' );
230 | return false;
231 | }
232 |
233 | /**
234 | * Fetch a queue by name.
235 | *
236 | * @var QueueInterface $queue
237 | */
238 | $queue = $this->queue_container->get( $queue_name );
239 |
240 | if ( ! $queue instanceof QueueInterface ) {
241 | WP_CLI::error( "No queue found with the name \"$queue_name\"." );
242 | return false;
243 | }
244 |
245 | try {
246 | $queue->delete();
247 | WP_CLI::success( "The queue \"$queue_name\" was deleted successfully!" );
248 | return true;
249 | }
250 | catch ( Exception $err ) {
251 | WP_CLI::error( 'An error occurred while deleting the queue: ' . $err->getMessage() );
252 | return false;
253 | }
254 | }
255 |
256 | /**
257 | * Check the number of entries in a queue.
258 | *
259 | * phpcs:disable
260 | *
261 | * ## OPTIONS
262 | *
263 | *
264 | * : The unique queue name.
265 | *
266 | * ## EXAMPLES
267 | *
268 | * # Check the size of a queue with the name 'my_queue'.
269 | * $ wp queue size my_queue
270 | * Success: There are 5 entries in the queue.
271 | *
272 | * phpcs:enable
273 | *
274 | * @param array $args The command parameters.
275 | * @return boolean
276 | */
277 | public function size( array $args = [] ) : bool {
278 | $queue_name = $args[0] ?? null;
279 |
280 | if ( empty( $queue_name ) ) {
281 | WP_CLI::error( 'Please define the queue name as the first command argument.' );
282 | return false;
283 | }
284 |
285 | /**
286 | * Fetch a queue by name.
287 | *
288 | * @var QueueInterface $queue
289 | */
290 | $queue = $this->queue_container->get( $queue_name );
291 |
292 | if ( ! $queue instanceof QueueInterface ) {
293 | WP_CLI::error( "No queue found with the name \"$queue_name\"." );
294 | return false;
295 | }
296 |
297 | try {
298 | $size_text = sprintf(
299 | ngettext( 'is %d entry', 'are %d entries', $queue->size(), ),
300 | $queue->size()
301 | );
302 |
303 | WP_CLI::success( "There $size_text in the queue." );
304 | return true;
305 | }
306 | catch ( Exception $err ) {
307 | WP_CLI::error( 'An error occurred while getting the queue size: ' . $err->getMessage() );
308 | return false;
309 | }
310 | }
311 |
312 | /**
313 | * Fetch new entries and add them to the queue.
314 | *
315 | * phpcs:disable
316 | *
317 | * ## OPTIONS
318 | *
319 | *
320 | * : The unique queue name.
321 | *
322 | * ## EXAMPLES
323 | *
324 | * # Fetch and enqueue new entries to the queue by the name 'my_queue'.
325 | * $ wp queue fetch my_queue
326 | * Success: "Entries for queue "my_queue" were enqueued successfully!"
327 | *
328 | * phpcs:enable
329 | *
330 | * @param array $args The command parameters.
331 | * @return boolean
332 | */
333 | public function fetch( array $args = [] ) : bool {
334 | $queue_name = $args[0] ?? null;
335 |
336 | if ( empty( $queue_name ) ) {
337 | WP_CLI::error( 'Please define the queue name as the second command argument.' );
338 | return false;
339 | }
340 |
341 | // Default the queue value to null.
342 | $queue = null;
343 |
344 | /**
345 | * Fetch a queue by name.
346 | *
347 | * @var QueueInterface $queue
348 | */
349 | $queue = $this->queue_container->get( $queue_name );
350 |
351 | if ( ! $queue instanceof QueueInterface ) {
352 | WP_CLI::error( "No queue found with the name \"$queue_name\"." );
353 | return false;
354 | }
355 |
356 | try {
357 | $enqueuer = new Enqueuer( $this->logger );
358 | }
359 | catch ( Exception $err ) {
360 | WP_CLI::error( $err->getMessage() );
361 | return false;
362 | }
363 |
364 | try {
365 | $enqueuer->fetch( $queue );
366 | WP_CLI::success( "Entries for queue \"$queue_name\" were enqueued successfully!" );
367 | return true;
368 | }
369 | catch ( Exception $err ) {
370 | WP_CLI::error( $err->getMessage() );
371 | return false;
372 | }
373 | }
374 |
375 | /**
376 | * Dequeue a single entry from a queue.
377 | *
378 | * phpcs:disable
379 | *
380 | * ## OPTIONS
381 | *
382 | *
383 | * : The unique queue name.
384 | *
385 | * ## EXAMPLES
386 | *
387 | * # Dequeue a single entry from a queue with the name 'my_queue'.
388 | * $ wp queue dequeue my_queue
389 | * Success: Dequeue for "my_queue" was executed successfully!
390 | *
391 | * phpcs:enable
392 | *
393 | * @param array $args The command parameters.
394 | * @return boolean True for success, false on error.
395 | */
396 | public function dequeue( array $args = [] ) : bool {
397 | $queue_name = $args[0] ?? null;
398 |
399 | if ( empty( $queue_name ) ) {
400 | WP_CLI::error( 'Please define the queue name as the second command argument.' );
401 | return false;
402 | }
403 |
404 | // Default the queue value to null.
405 | $queue = null;
406 |
407 | /**
408 | * Fetch a queue by name.
409 | *
410 | * @var QueueInterface $queue
411 | */
412 | $queue = $this->queue_container->get( $queue_name );
413 |
414 | if ( ! $queue instanceof QueueInterface ) {
415 | WP_CLI::error( "No queue found with the name \"$queue_name\"." );
416 | return false;
417 | }
418 |
419 | try {
420 | $dequeuer = new Dequeuer( $this->logger );
421 | }
422 | catch ( Exception $err ) {
423 | WP_CLI::error( $err->getMessage() );
424 | return false;
425 | }
426 |
427 | $success = $dequeuer->dequeue( $queue );
428 |
429 | if ( $success ) {
430 | WP_CLI::success( "Dequeue for the queue \"$queue_name\" was executed successfully!" );
431 | }
432 | else {
433 | if ( $queue->is_empty() ) {
434 | return true;
435 | }
436 |
437 | WP_CLI::error(
438 | 'An error occurred while executing the dequeue!
439 | See the dequeuer and/or queue log for detailed information.'
440 | );
441 | }
442 |
443 | return $success instanceof EntryInterface;
444 | }
445 | }
446 |
--------------------------------------------------------------------------------
/src/Dequeuer.php:
--------------------------------------------------------------------------------
1 | logger = $logger ?? wpq()->get_logger();
34 | }
35 |
36 | /**
37 | * Dequeues an entry from a queue.
38 | *
39 | * @param QueueInterface $queue The queue name.
40 | *
41 | * @return EntryInterface|null The dequeued entry or null.
42 | */
43 | public function dequeue( QueueInterface $queue ) : ?EntryInterface {
44 | if ( ! $queue instanceof QueueInterface ) {
45 | $this->logger->error(
46 | 'Unable to dequeue. The queue is not of type: ' . QueueInterface::class . '.',
47 | [ __CLASS__ ]
48 | );
49 | return null;
50 | }
51 |
52 | $name = $queue->get_name();
53 |
54 | if ( ! $queue->exists() ) {
55 | $this->logger->error( "Unable to find the queue: $name.", [ __CLASS__ ] );
56 | return null;
57 | }
58 |
59 | // Run the first entry.
60 | try {
61 | // Run hooks before the dequeue is executed.
62 | do_action( 'wpq_before_dequeue', $queue );
63 | do_action( 'wpq_before_dequeue_' . $name, $queue );
64 |
65 | $entry = $queue->dequeue();
66 |
67 | // Run hooks after the dequeue is done.
68 | do_action( 'wpq_after_dequeue', $queue, $entry );
69 | do_action( 'wpq_after_dequeue_' . $name, $queue, $entry );
70 |
71 | return $entry;
72 | }
73 | catch ( \Exception $error ) {
74 | if ( $this->logger ) {
75 | $this->logger->error(
76 | "An error occurred while dequeueing from queue: $name.",
77 | [
78 | 'message' => $error->getMessage(),
79 | 'file' => $error->getFile(),
80 | 'line' => $error->getLine(),
81 | ]
82 | );
83 | }
84 |
85 | return null;
86 | }
87 | }
88 | }
89 |
--------------------------------------------------------------------------------
/src/Enqueuer.php:
--------------------------------------------------------------------------------
1 | logger = $logger ?? wpq()->get_logger();
34 | }
35 |
36 | /**
37 | * Fetch new entries and add them to the queue.
38 | *
39 | * @param QueueInterface $queue The queue name.
40 | *
41 | * @return int Number of entries enqueued. Negative integer on error.
42 | */
43 | public function fetch( QueueInterface $queue ) : int {
44 | $name = $queue->get_name();
45 |
46 | if ( ! $queue->exists() ) {
47 | $this->logger->error( "Unable to find the queue: $name.", [ __CLASS__ ] );
48 | return false;
49 | }
50 |
51 | // Fetch new entries.
52 | try {
53 | // Run hooks before the entries are fetched.
54 | do_action( 'wpq_before_fetch', $queue );
55 | do_action( 'wpq_before_fetch_' . $name, $queue );
56 |
57 | $fetcher = $queue->get_entry_fetcher();
58 | $entries = $fetcher->fetch();
59 |
60 | // Run hooks after the entries are fetched.
61 | do_action( 'wpq_after_fetch', $queue, $entries );
62 | do_action( 'wpq_after_fetch_' . $name, $queue, $entries );
63 |
64 | // Add entries to the queue.
65 | if ( ! empty( $entries ) ) {
66 | // Wrap data into entries if not already wrapped.
67 | $wrapped_entries = wpq_wrap_items_to_entries( $entries );
68 |
69 | // Enqueue entries.
70 | array_walk(
71 | $wrapped_entries,
72 | function( EntryInterface $entry ) use ( $queue ) {
73 | $this->enqueue( $queue, $entry );
74 | }
75 | );
76 | }
77 |
78 | // Run hooks after the entries are the process is completed.
79 | do_action( 'wpq_after_fetch_complete', $queue, $entries );
80 | do_action( 'wpq_after_fetch_complete_' . $name, $queue, $entries );
81 |
82 | return count( $entries );
83 | }
84 | catch ( \Exception $error ) {
85 | if ( $this->logger ) {
86 | $this->logger->error(
87 | "An error occurred while enqueueing new entries to queue: $name.",
88 | [
89 | 'message' => $error->getMessage(),
90 | 'file' => $error->getFile(),
91 | 'line' => $error->getLine(),
92 | ]
93 | );
94 | }
95 |
96 | return -1;
97 | }
98 | }
99 |
100 | /**
101 | * Enqueue a single entry into a queue.
102 | *
103 | * @param QueueInterface $queue The queue name.
104 | * @param EntryInterface $entry The entry.
105 | *
106 | * @return bool True on success, false on failure.
107 | */
108 | public function enqueue( QueueInterface $queue, EntryInterface $entry ) : bool {
109 | $name = $queue->get_name();
110 |
111 | if ( ! $queue->exists() ) {
112 | $this->logger->error( "Unable to find the queue: $name.", [ __CLASS__ ] );
113 | return false;
114 | }
115 |
116 | // Fetch new entries.
117 | try {
118 | // Run hooks before the entries are fetched.
119 | do_action( 'wpq_before_enqueue', $queue, $entry );
120 | do_action( 'wpq_before_enqueue_' . $name, $queue, $entry );
121 |
122 | $queue->enqueue( $entry );
123 |
124 | // Run hooks after the entries are added to the queue.
125 | do_action( 'wpq_after_enqueue', $queue, $entry );
126 | do_action( 'wpq_after_enqueue_' . $name, $queue, $entry );
127 |
128 | return true;
129 | }
130 | catch ( \Exception $error ) {
131 | if ( $this->logger ) {
132 | $this->logger->error(
133 | "An error occurred while enqueueing an entry to queue: $name.",
134 | [
135 | // Use this filter to sanitize sensitive data.
136 | 'data' => apply_filters( 'wpq_entry_data_log', $entry->get_data() ),
137 | 'message' => $error->getMessage(),
138 | 'file' => $error->getFile(),
139 | 'line' => $error->getLine(),
140 | ]
141 | );
142 | }
143 |
144 | return false;
145 | }
146 | }
147 | }
148 |
--------------------------------------------------------------------------------
/src/Entry.php:
--------------------------------------------------------------------------------
1 | data = $data;
32 |
33 | return $this;
34 | }
35 |
36 | /**
37 | * Getter for the data.
38 | *
39 | * @return mixed
40 | */
41 | public function get_data() {
42 | return $this->data;
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/src/Exception/QueueContainerException.php:
--------------------------------------------------------------------------------
1 | name;
62 | }
63 |
64 | /**
65 | * Get the entry handler.
66 | *
67 | * @return EntryHandlerInterface|null
68 | */
69 | public function get_entry_handler() : ?EntryHandlerInterface {
70 | return $this->entry_handler;
71 | }
72 |
73 | /**
74 | * Get the entry fetcher.
75 | *
76 | * @return EntryFetcherInterface|null
77 | */
78 | public function get_entry_fetcher() : ?EntryFetcherInterface {
79 | return $this->entry_fetcher;
80 | }
81 |
82 | /**
83 | * Get the entries.
84 | *
85 | * @return array|null
86 | */
87 | public function get_entries() : ?array {
88 | return $this->entries;
89 | }
90 |
91 | /**
92 | * Get the logger.
93 | *
94 | * @return LoggerInterface|null
95 | */
96 | public function get_logger() : ?LoggerInterface {
97 | return $this->logger;
98 | }
99 |
100 | /**
101 | * Set the entry handler.
102 | *
103 | * @param EntryHandlerInterface|null $entry_handler The callable to handle the single entry.
104 | *
105 | * @return Base
106 | */
107 | public function set_entry_handler( ?EntryHandlerInterface $entry_handler ) {
108 | $this->entry_handler = $entry_handler;
109 |
110 | return $this;
111 | }
112 |
113 | /**
114 | * Set the entry fetcher.
115 | *
116 | * @param EntryFetcherInterface|null $entry_fetcher The callable to handle the single entry.
117 | *
118 | * @return Base
119 | */
120 | public function set_entry_fetcher( ?EntryFetcherInterface $entry_fetcher ) {
121 | $this->entry_fetcher = $entry_fetcher;
122 |
123 | return $this;
124 | }
125 |
126 | /**
127 | * Set the entries.
128 | * Passed items will be wrapped into entries.
129 | *
130 | * @param EntryInterface[]|array $entries Array of entries or other items.
131 | */
132 | public function set_entries( ?array $entries ) {
133 | $this->entries = wpq_wrap_items_to_entries( $entries );
134 | }
135 |
136 | /**
137 | * Setter for the logger.
138 | *
139 | * @param LoggerInterface $logger A PSR-3 compatible logger instance.
140 | */
141 | public function set_logger( LoggerInterface $logger ) {
142 | $this->logger = $logger;
143 | }
144 | }
145 |
--------------------------------------------------------------------------------
/src/Instance/RedisQueue.php:
--------------------------------------------------------------------------------
1 | name = $name;
76 | $this->entry_fetcher = $fetcher;
77 | $this->entry_handler = $handler;
78 | $this->redis = $this->get_redis_instance();
79 |
80 | // Set the default logger.
81 | $this->logger = new Logger();
82 | }
83 |
84 | /**
85 | * A safe method for accessing the Redis instance in Redis Object Cache.
86 | *
87 | * @return \Redis|null
88 | */
89 | private function get_redis_instance() {
90 | global $wp_object_cache;
91 |
92 | $redis = null;
93 |
94 | if ( method_exists( $wp_object_cache, 'redis_instance' ) ) {
95 | $redis = $wp_object_cache->redis_instance();
96 | }
97 |
98 | return apply_filters( 'wpq_redis_instance', $redis );
99 | }
100 |
101 | /**
102 | * Loads the entry handler from Redis.
103 | *
104 | * @return void
105 | */
106 | protected function load_entry_handler() {
107 | // Try to load entry handler from storage.
108 | try {
109 | if ( empty( $this->entry_handler ) && $this->exists() ) {
110 | $raw = $this->redis->get( $this->get_storage_key() );
111 | $object = maybe_unserialize( $raw );
112 | $this->entry_handler = $object->entry_handler ?? null;
113 | }
114 | }
115 | catch ( Exception $e ) {
116 | $this->logger->error(
117 | 'RedisCacheQueue - An error occurred while loading the entry handler.',
118 | [
119 | 'name' => $this->name,
120 | 'message' => $e->getMessage(),
121 | 'file' => $e->getFile(),
122 | 'line' => $e->getLine(),
123 | ]
124 | );
125 | }
126 | }
127 |
128 | /**
129 | * Get the storage key for the queue.
130 | *
131 | * @return string
132 | */
133 | public function get_storage_key() : string {
134 | return $this->prefix_name( $this->name );
135 | }
136 |
137 | /**
138 | * Get the storage key for the queue entries list.
139 | *
140 | * @return string
141 | */
142 | protected function get_entries_key() : string {
143 | return $this->prefix_name( $this->name ) . '_entries';
144 | }
145 |
146 | /**
147 | * Get the queue lock key.
148 | *
149 | * @return string
150 | */
151 | protected function get_lock_key() : string {
152 | return 'lock:' . $this->get_storage_key();
153 | }
154 |
155 | /**
156 | * Save the queue. Rewrites all entries.
157 | */
158 | public function save() {
159 | // Save entries first.
160 | $entries = $this->entries;
161 | $key = $this->get_entries_key();
162 | try {
163 | // Delete old entries first.
164 | $this->clear();
165 |
166 | if ( ! empty( $entries ) ) {
167 | // Push all serialized entries into the empty list.
168 | $this->redis->rPush( $key, ...array_map( 'maybe_serialize', array_values( $entries ) ) );
169 | }
170 | }
171 | catch ( Exception $e ) {
172 | $this->logger->info(
173 | 'RedisCacheQueue - Unable to save the entries. Deleting it. Error: ' . $e->getMessage()
174 | );
175 | $this->delete();
176 | return;
177 | }
178 |
179 | // Entries should not be stored with the object.
180 | $this->entries = null;
181 |
182 | // Store this queue for a month.
183 | try {
184 | $success = $this->redis->setex( $this->get_storage_key(), MONTH_IN_SECONDS, serialize( $this ) ); // phpcs:ignore
185 |
186 | // If unable to save the queue, delete it to prevent jamming any processes.
187 | if ( ! $success ) {
188 | $this->logger->error( 'RedisCacheQueue - Unable to save the queue. "setex" failed. Deleting queue..' );
189 | $this->delete();
190 | return;
191 | }
192 | else {
193 | $this->logger->info( 'RedisCacheQueue - "' . $this->name . '" saved!' );
194 | }
195 | }
196 | catch ( Exception $e ) {
197 | $this->logger->error(
198 | 'RedisCacheQueue - Unable to save the queue. Deleting it. Error: ' . $e->getMessage()
199 | );
200 | $this->delete();
201 | return;
202 | }
203 |
204 | // Put back entries.
205 | $this->entries = $entries;
206 | }
207 |
208 | /**
209 | * Delete the queue.
210 | *
211 | * @throws Exception An exception is thrown if the deletion fails.
212 | */
213 | public function delete() {
214 | try {
215 |
216 | // Run hooks before the queue is deleted.
217 | do_action( 'wpq_before_delete', $this );
218 | do_action( 'wpq_before_delete_' . $this->get_name(), $this );
219 |
220 | // Expire lock.
221 | $this->redis->pExpire( $this->get_lock_key(), 1 );
222 |
223 | // Expire basic data.
224 | $this->redis->pExpire( $this->get_storage_key(), 1 );
225 |
226 | // Clear entries.
227 | $this->clear();
228 |
229 | $this->exists = false;
230 |
231 | // Run hooks after the queue is deleted.
232 | do_action( 'wpq_after_delete', $this );
233 | do_action( 'wpq_after_delete_' . $this->get_name(), $this );
234 | }
235 | catch ( Exception $e ) {
236 | $this->logger->error( 'RedisCacheQueue - Unable to delete queue. Error: ' . $e->getMessage() );
237 | throw $e;
238 | }
239 | }
240 |
241 | /**
242 | * Clear all entries.
243 | *
244 | * @return void
245 | * @throws Exception Throws an error if Redis commands fail.
246 | */
247 | public function clear() {
248 | $key = $this->get_entries_key();
249 |
250 | // Delete the entry list by trimming off elements in batches of 100.
251 | try {
252 |
253 | // Run hooks before the queue is cleared.
254 | do_action( 'wpq_before_clear', $this );
255 | do_action( 'wpq_before_clear_' . $this->get_name(), $this );
256 |
257 | while ( $this->redis->llen( $key ) > 0 ) {
258 | $this->redis->ltrim( $key, 0, -99 );
259 | }
260 |
261 | // Run hooks after the queue is cleared.
262 | do_action( 'wpq_after_clear', $this );
263 | do_action( 'wpq_after_clear_' . $this->get_name(), $this );
264 | }
265 | catch ( Exception $e ) {
266 | $this->logger->error( 'RedisCacheQueue - Unable to clear the queue. Error: ' . $e->getMessage() );
267 | throw $e;
268 | }
269 | }
270 |
271 | /**
272 | * Check if this queue exists.
273 | */
274 | public function exists() : bool {
275 | if ( $this->exists ) {
276 | return true;
277 | }
278 | try {
279 | $this->exists = $this->redis->exists( $this->get_storage_key() ) === 1;
280 |
281 | return $this->exists;
282 | }
283 | catch ( Exception $e ) {
284 | $this->logger->error( 'RedisCacheQueue - Unable to check existence. Error: ' . $e->getMessage() );
285 | return false;
286 | }
287 | }
288 |
289 | /**
290 | * Check whether the queue is empty.
291 | *
292 | * @return bool
293 | */
294 | public function is_empty() : bool {
295 | return $this->size() === 0;
296 | }
297 |
298 | /**
299 | * Checks the number of entries in the queue.
300 | *
301 | * @return int
302 | */
303 | public function size() : int {
304 | try {
305 | return (int) $this->redis->llen( $this->get_entries_key() );
306 | }
307 | catch ( Exception $e ) {
308 | $this->logger->error( 'RedisCacheQueue - Unable to read queue length. Error: ' . $e->getMessage() );
309 |
310 | return 0;
311 | }
312 | }
313 |
314 | /**
315 | * Run an event from the queue and store the rest.
316 | *
317 | * @return EntryInterface|null The dequeued entry or null.
318 | * @throws Exception An exception is thrown if the entry handler is not a callable.
319 | */
320 | public function dequeue() : ?EntryInterface {
321 | $this->logger->info( 'RedisCacheQueue - Dequeueing event from queue: ' . $this->name );
322 |
323 | $lock_ttl = apply_filters( 'wpq_cache_lock_ttl', 5 * MINUTE_IN_SECONDS );
324 | $lock_key = $this->get_lock_key();
325 | $lock_set = false;
326 |
327 | try {
328 | // Nothing to do if the queue is empty.
329 | if ( $this->is_empty() ) {
330 | $this->logger->info( 'RedisCacheQueue - Nothing to dequeue. The queue is empty.', [ $this->name ] );
331 | return null;
332 | }
333 |
334 | $this->load_entry_handler();
335 |
336 | // Do nothing if the handler is not the correct type.
337 | if ( ! $this->entry_handler instanceof EntryHandlerInterface ) {
338 | throw new Exception( 'RedisCacheQueue - The entry handler is the wrong type.' );
339 | }
340 |
341 | // Try to set a lock. If this returns true, the queue was successfully locked.
342 | // Depending on PHP version this function returns 1 or true.
343 | $lock_set = (bool) $this->redis->setnx( $lock_key, 1 );
344 |
345 | // Because of different return values with the setnx() we need to use boolval() here.
346 | if ( $lock_set === false ) {
347 | $this->logger->info(
348 | 'RedisCacheQueue - Stopping a dequeue process. The queue is locked.',
349 | [ $this->name ]
350 | );
351 |
352 | return null;
353 | }
354 |
355 | // Do not lock for eternity.
356 | $this->redis->expire( $lock_key, $lock_ttl );
357 |
358 | $raw_entry = $this->redis->lIndex( $this->get_entries_key(), 0 );
359 | $entry = maybe_unserialize( $raw_entry );
360 |
361 | $this->entry_handler->handle( $entry );
362 |
363 | // Handling was successful. Pop the entry out.
364 | $this->redis->lPop( $this->get_entries_key() );
365 |
366 | if ( $this->is_empty() ) {
367 | $this->logger->info( 'RedisCacheQueue - The queue is finished.', [ $this->name ] );
368 | }
369 | else {
370 | $this->logger->info( 'RedisCacheQueue - Dequeued.', [ $this->name ] );
371 | }
372 | }
373 | catch ( Exception $e ) {
374 | $this->logger->error(
375 | 'RedisCacheQueue - An error occurred while dequeueing.',
376 | [
377 | 'name' => $this->name,
378 | 'message' => $e->getMessage(),
379 | 'file' => $e->getFile(),
380 | 'line' => $e->getLine(),
381 | ]
382 | );
383 | }
384 |
385 | if ( $lock_set ) {
386 | try {
387 | // Expire the lock after 1ms.
388 | // This is more optimized than deleting a key.
389 | $this->redis->pExpire( $lock_key, 1 );
390 | }
391 | catch ( Exception $e ) {
392 | $this->logger->error(
393 | "RedisCacheQueue - An error occurred while deleting the lock. The queue will remain locked.",
394 | [
395 | 'name' => $this->name,
396 | 'message' => $e->getMessage(),
397 | 'file' => $e->getFile(),
398 | 'line' => $e->getLine(),
399 | ]
400 | );
401 |
402 | $entry = null;
403 | }
404 | }
405 |
406 | return $entry ?? null;
407 | }
408 |
409 | /**
410 | * Adds an entry at the and of the queue.
411 | *
412 | * @param EntryInterface $entry The entry.
413 | */
414 | public function enqueue( EntryInterface $entry ) {
415 | try {
416 | $name = $this->get_name();
417 | $length = $this->redis->rPush( $this->get_entries_key(), maybe_serialize( $entry ) );
418 | $this->logger->info( "RedisCacheQueue - Enqueued a new entry into queue: \"$name\". Length: $length." );
419 | }
420 | catch ( Exception $err ) {
421 | $message = $err->getMessage();
422 | $this->logger->error(
423 | "RedisCacheQueue - Unable the enqueue a new entry into queue: \"$name\". Error: $message",
424 | $err->getTrace()
425 | );
426 | return null;
427 | }
428 | }
429 |
430 | /**
431 | * Checks if entry exists in queue.
432 | *
433 | * @param EntryInterface $entry The entry.
434 | *
435 | * @return bool
436 | */
437 | public function entry_exists( EntryInterface $entry ) : bool {
438 | try {
439 | $entry_exists = $this->redis->EXISTS( $this->get_entries_key(), maybe_serialize( $entry ) );
440 |
441 | if ( $entry_exists ) {
442 | $name = $this->get_name();
443 | $id = $entry->get_data()['entry_id'];
444 | $this->logger->info( "Entry $id already in queue \"$name\", skipping" );
445 | }
446 | return $entry_exists;
447 | }
448 | catch ( Exception $e ) {
449 | $this->logger->error( 'RedisCacheQueue - Unable to check entry key. Error: ' . $e->getMessage() );
450 |
451 | return false;
452 | }
453 | }
454 | }
455 |
--------------------------------------------------------------------------------
/src/Interfaces/EntryFetcherInterface.php:
--------------------------------------------------------------------------------
1 | log_level = GENIEM_LOG_LEVEL;
91 | }
92 | // Set from the argument.
93 | if ( $log_level ) {
94 | $this->log_level = $log_level;
95 | }
96 | }
97 |
98 | /**
99 | * Log a debug message.
100 | *
101 | * @param string $message The log message.
102 | * @param array $context The error context data.
103 | */
104 | public function debug( $message, array $context = [] ) {
105 | if ( static::DEBUG >= $this->log_level ) {
106 | $this->log( 'DEBUG', $message, $context );
107 | }
108 | }
109 |
110 | /**
111 | * Log an info message.
112 | *
113 | * @param string $message The log message.
114 | * @param array $context The error context data.
115 | */
116 | public function info( $message, array $context = [] ) {
117 | if ( static::INFO >= $this->log_level ) {
118 | $this->log( 'INFO', $message, $context );
119 | }
120 | }
121 |
122 | /**
123 | * Log a notice message.
124 | *
125 | * @param string $message The log message.
126 | * @param array $context The error context data.
127 | */
128 | public function notice( $message, array $context = [] ) {
129 | if ( static::NOTICE >= $this->log_level ) {
130 | $this->log( 'NOTICE', $message, $context );
131 | }
132 | }
133 |
134 | /**
135 | * Log a warning message.
136 | *
137 | * @param string $message The log message.
138 | * @param array $context The error context data.
139 | */
140 | public function warning( $message, array $context = [] ) {
141 | if ( static::WARNING >= $this->log_level ) {
142 | $this->log( 'WARNING', $message, $context );
143 | }
144 | }
145 |
146 | /**
147 | * Log an error message.
148 | *
149 | * @param string $message The log message.
150 | * @param array $context The error context data.
151 | */
152 | public function error( $message, array $context = [] ) {
153 | if ( static::ERROR >= $this->log_level ) {
154 | $this->log( 'ERROR', $message, $context );
155 | }
156 | }
157 |
158 | /**
159 | * Log a critical message.
160 | *
161 | * @param string $message The log message.
162 | * @param array $context The error context data.
163 | */
164 | public function critical( $message, array $context = [] ) {
165 | if ( static::CRITICAL >= $this->log_level ) {
166 | $this->log( 'CRITICAL', $message, $context );
167 | }
168 | }
169 |
170 | /**
171 | * Log an alert message.
172 | *
173 | * @param string $message The log message.
174 | * @param array $context The error context data.
175 | */
176 | public function alert( $message, array $context = [] ) {
177 | if ( static::ALERT >= $this->log_level ) {
178 | $this->log( 'ALERT', $message, $context );
179 | }
180 | }
181 |
182 | /**
183 | * Log an emergency message.
184 | *
185 | * @param string $message The log message.
186 | * @param array $context The error context data.
187 | */
188 | public function emergency( $message, array $context = [] ) {
189 | if ( static::EMERGENCY >= $this->log_level ) {
190 | $this->log( 'EMERGENCY', $message, $context );
191 | }
192 | }
193 |
194 | /**
195 | * The actual logging method.
196 | *
197 | * @param mixed $level The log level.
198 | * @param string $message The log message.
199 | * @param array $context The error context data.
200 | */
201 | public function log( $level, $message, array $context = [] ) : void {
202 | $string_context = empty( $context ) ?
203 | '' :
204 | ' - Context: ' . addslashes( str_replace( PHP_EOL, '', print_r( $context, true ) ) ); // phpcs:ignore
205 | $string_context = preg_replace( '/(\s+)/', ' ', $string_context ); // Remove multiple consecutive spaces.
206 | if ( defined( 'WP_CLI' ) && WP_CLI ) {
207 | \WP_CLI::log( "Queue Logger - $level - $message$string_context" );
208 | }
209 | else {
210 | error_log( "Queue Logger - $level - $message$string_context" ); // phpcs:ignore
211 | }
212 | }
213 | }
214 |
--------------------------------------------------------------------------------
/src/Mock/MockEntryFetcher.php:
--------------------------------------------------------------------------------
1 | data = $data;
26 | }
27 |
28 | /**
29 | * A setter for the mock data.
30 | *
31 | * @param array $data The mock data.
32 | */
33 | public function set_data( $data ) {
34 | $this->data = $data;
35 | }
36 |
37 | /**
38 | * Fetch the mock data.
39 | *
40 | * @return array|null
41 | */
42 | public function fetch() : ?array {
43 | return $this->data;
44 | }
45 | }
46 |
--------------------------------------------------------------------------------
/src/Mock/MockEntryHandler.php:
--------------------------------------------------------------------------------
1 | get_logger()->info( 'Handling an entry.', [ 'entry' => $entry ] );
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/src/Mock/MockQueue.php:
--------------------------------------------------------------------------------
1 | is_saved;
37 | }
38 |
39 | /**
40 | * Queue constructor.
41 | *
42 | * @param string $name A unique name for the queue.
43 | * @param EntryFetcherInterface $fetcher The entry fetcher instance.
44 | * @param EntryHandlerInterface $handler The entry handler instance.
45 | */
46 | public function __construct( string $name, EntryFetcherInterface $fetcher, EntryHandlerInterface $handler ) {
47 | $this->name = $name;
48 | $this->entry_fetcher = $fetcher;
49 | $this->entry_handler = $handler;
50 |
51 | // Set the default logger.
52 | $this->logger = new Logger();
53 | }
54 |
55 | /**
56 | * The simple queue always exists once instantiated.
57 | *
58 | * @return bool
59 | */
60 | public function exists(): bool {
61 | return true;
62 | }
63 |
64 | /**
65 | * Is the queue empty?
66 | *
67 | * @return bool
68 | */
69 | public function is_empty(): bool {
70 | return empty( $this->queue );
71 | }
72 |
73 | /**
74 | * Get the queue size.
75 | *
76 | * @return int
77 | */
78 | public function size(): int {
79 | return count( $this->queue );
80 | }
81 |
82 | /**
83 | * Pop the first element out of the queue.
84 | *
85 | * @return EntryInterface|null The dequeued entry or null.
86 | */
87 | public function dequeue(): ?EntryInterface {
88 | if ( empty( $this->queue ) ) {
89 | return null;
90 | }
91 |
92 | $entry = $this->queue[0];
93 |
94 | if ( $entry instanceof EntryInterface ) {
95 | $this->entry_handler->handle( $entry );
96 |
97 | unset( $this->queue[0] );
98 |
99 | // Reset indexes.
100 | $this->queue = array_values( $this->queue );
101 |
102 | return $entry;
103 | }
104 |
105 | return null;
106 | }
107 |
108 | /**
109 | * Enqueue a single entry.
110 | *
111 | * @param EntryInterface $entry The entry instance.
112 | */
113 | public function enqueue( EntryInterface $entry ) {
114 | array_push( $this->queue, $entry );
115 | }
116 |
117 | /**
118 | * Set the queue from the passed entries.
119 | *
120 | * @param array|EntryInterface[]|null $entries The entries/items.
121 | */
122 | public function set_entries( $entries ) {
123 | parent::set_entries( $entries );
124 |
125 | $this->queue = $this->entries;
126 | }
127 |
128 | /**
129 | * No saving required for this simple queue.
130 | */
131 | public function save() {
132 | $this->is_saved = true;
133 | }
134 |
135 | /**
136 | * Delete this queue instance.
137 | */
138 | public function delete() {
139 | // There is no way to internally remove the instance. Just clear the queue.
140 | $this->clear();
141 | }
142 |
143 | /**
144 | * @inheritDoc
145 | */
146 | public function clear() {
147 | $this->queue = [];
148 | }
149 | }
--------------------------------------------------------------------------------
/src/QueueContainer.php:
--------------------------------------------------------------------------------
1 | queues[ $queue->get_name() ] ) ) {
26 | $this->queues[ $queue->get_name() ] = $queue;
27 | }
28 | }
29 |
30 | /**
31 | * Adds a queue even if one with the id already exists.
32 | *
33 | * @param QueueInterface $queue The queue instance.
34 | */
35 | public function replace( QueueInterface $queue ) {
36 | $this->queues[ $queue->get_name() ] = $queue;
37 | }
38 |
39 | /**
40 | * Get the queue instance by its name.
41 | *
42 | * @param string $id The queue name is the id.
43 | *
44 | * @return QueueInterface The found queue instance.
45 | * @throws QueueNotFoundException If no queue is found, an exception is thrown.
46 | */
47 | public function get( $id ) {
48 | if ( ! isset( $this->queues[ $id ] ) ) {
49 | throw new QueueNotFoundException( "No queue found for key: $id" );
50 | }
51 |
52 | return $this->queues[ $id ];
53 | }
54 |
55 | /**
56 | * Check whether a queue is set or not.
57 | *
58 | * @param string $id The queue name is the id.
59 | *
60 | * @return bool
61 | */
62 | public function has( $id ) {
63 | return isset( $this->queues[ $id ] );
64 | }
65 | }
66 |
--------------------------------------------------------------------------------
/src/QueueCreator.php:
--------------------------------------------------------------------------------
1 | queue = $queue;
31 | }
32 |
33 | /**
34 | * Fetches the queue entries and saves it.
35 | */
36 | public function create() {
37 | $fetcher = $this->queue->get_entry_fetcher();
38 |
39 | if ( $fetcher instanceof EntryFetcherInterface ) {
40 | // Run hooks before the entries are fetched during create.
41 | do_action( 'wpq_before_create_fetch', $this->queue );
42 | do_action( 'wpq_before_create_fetch_' . $this->queue->get_name(), $this->queue );
43 |
44 | $entries = $this->queue->get_entry_fetcher()->fetch();
45 |
46 | // Run hooks after the entries are fetched.
47 | do_action( 'wpq_after_create_fetch', $this->queue, $entries );
48 | do_action( 'wpq_after_create_fetch_' . $this->queue->get_name(), $this->queue, $entries );
49 |
50 | $this->queue->set_entries( $entries );
51 | }
52 |
53 | // Run hooks before the queue is saved.
54 | do_action( 'wpq_before_save', $this->queue );
55 | do_action( 'wpq_before_save_' . $this->queue->get_name(), $this->queue );
56 |
57 | $this->queue->save();
58 |
59 | // Run hooks after the queue is saved.
60 | do_action( 'wpq_after_save', $this->queue );
61 | do_action( 'wpq_after_save_' . $this->queue->get_name(), $this->queue );
62 | }
63 | }
64 |
--------------------------------------------------------------------------------
/src/QueuePlugin.php:
--------------------------------------------------------------------------------
1 | version;
69 | }
70 |
71 | /**
72 | * Get the plugin directory path.
73 | *
74 | * @return string
75 | */
76 | public function get_plugin_path() : string {
77 | return $this->plugin_path;
78 | }
79 |
80 | /**
81 | * Get the plugin directory uri.
82 | *
83 | * @return string
84 | */
85 | public function get_plugin_uri() : string {
86 | return $this->plugin_uri;
87 | }
88 |
89 | /**
90 | * Get the queue_container.
91 | *
92 | * @return ContainerInterface
93 | */
94 | public function get_queue_container() : ContainerInterface {
95 | return $this->queue_container;
96 | }
97 |
98 | /**
99 | * Use this method to override the default queue container instance.
100 | *
101 | * @param ContainerInterface $queue_container The queue container instance.
102 | *
103 | * @return QueuePlugin Return self to enable chaining.
104 | */
105 | public function set_queue_container( ContainerInterface $queue_container ) : QueuePlugin {
106 | $this->queue_container = $queue_container;
107 |
108 | return $this;
109 | }
110 |
111 | /**
112 | * Get the logger. If none is set use the default logger.
113 | *
114 | * @return LoggerInterface
115 | */
116 | public function get_logger() : LoggerInterface {
117 | return $this->logger ?? new Logger();
118 | }
119 |
120 | /**
121 | * Set the logger.
122 | *
123 | * @param ?LoggerInterface $logger The logger.
124 | *
125 | * @return QueuePlugin Return self to enable chaining.
126 | */
127 | public function set_logger( ?LoggerInterface $logger ) : QueuePlugin {
128 | $this->logger = $logger;
129 |
130 | return $this;
131 | }
132 |
133 | /**
134 | * Initialize the plugin by creating the singleton.
135 | *
136 | * @param string $version The current plugin version.
137 | * @param string $plugin_path The plugin path.
138 | *
139 | * @throws \Geniem\Queue\Exception\QueueContainerException If QueueContainer doesn't implement ContainerInterface.
140 | */
141 | public static function init( string $version, string $plugin_path ) : void {
142 | if ( empty( self::$instance ) ) {
143 | self::$instance = new self( $version, $plugin_path );
144 | self::$instance->init_container();
145 | self::$instance->hooks();
146 | self::$instance->init_cli();
147 | }
148 | }
149 |
150 | /**
151 | * Get the plugin instance.
152 | *
153 | * @return QueuePlugin
154 | */
155 | public static function plugin() : QueuePlugin {
156 | if ( static::$instance === null ) {
157 | static::init( '', dirname( __DIR__, 2 ) );
158 | }
159 |
160 | return static::$instance;
161 | }
162 |
163 | /**
164 | * Initialize the plugin functionalities.
165 | *
166 | * @param string $version The current plugin version.
167 | * @param string $plugin_path The plugin path.
168 | */
169 | protected function __construct( string $version, string $plugin_path ) {
170 | $this->version = $version;
171 | $this->plugin_path = $plugin_path;
172 | $this->plugin_uri = plugin_dir_url( $plugin_path ) . basename( $this->plugin_path );
173 | }
174 |
175 | /**
176 | * Add plugin hooks and filters.
177 | */
178 | protected function hooks() : void {
179 | // Queue plugin ready.
180 | do_action( 'wpq_init', $this );
181 | // The hook for adding queue instances.
182 | do_action( 'wpq_add_queue', $this->queue_container );
183 | }
184 |
185 | /**
186 | * Initializes the WP-CLI functionalities.
187 | *
188 | * @return void
189 | */
190 | protected function init_cli() : void {
191 | // Register the CLI commands if WP CLI is available.
192 | if ( defined( 'WP_CLI' ) && WP_CLI ) {
193 | \WP_CLI::add_command( 'queue', Commands::class, [ $this->queue_container ] );
194 | }
195 | }
196 |
197 | /**
198 | * Sets the default queue container.
199 | *
200 | * @throws QueueContainerException
201 | */
202 | protected function init_container() : void {
203 | $container = apply_filters( 'wpq_queue_container', new QueueContainer() );
204 |
205 | if ( ! $container instanceof ContainerInterface ) {
206 | $interface = ContainerInterface::class;
207 | throw new QueueContainerException( "The queue container must implement the $interface interface." );
208 | }
209 |
210 | $this->queue_container = $container;
211 | }
212 |
213 | /**
214 | * Initializes the logger through a filter.
215 | */
216 | protected function init_logger() : void {
217 | $this->logger = apply_filters( 'wpq_logger', new Logger() );
218 | }
219 |
220 | /**
221 | * Enqueue admin side scripts if they exist.
222 | */
223 | public function enqueue_admin_scripts() : void {
224 | // Get file modification times to enable more dynamic versioning.
225 | $css_mod_time = file_exists( $this->plugin_path . '/assets/dist/admin.css' )
226 | ? filemtime( $this->plugin_path . '/assets/dist/admin.css' )
227 | : $this->version;
228 | $js_mod_time = file_exists( $this->plugin_path . '/assets/dist/admin.js' )
229 | ? filemtime( $this->plugin_path . '/assets/dist/admin.js' )
230 | : $this->version;
231 |
232 | if ( file_exists( $this->plugin_path . '/assets/dist/admin.css' ) ) {
233 | wp_enqueue_style(
234 | 'import-controller-admin-css',
235 | $this->plugin_uri . '/assets/dist/admin.css',
236 | [],
237 | $css_mod_time,
238 | 'all'
239 | );
240 | }
241 |
242 | if ( file_exists( $this->plugin_path . '/assets/dist/admin.js' ) ) {
243 | wp_enqueue_script(
244 | 'import-controller-admin-js',
245 | $this->plugin_uri . '/assets/dist/admin.js',
246 | [ 'jquery' ],
247 | $js_mod_time,
248 | true
249 | );
250 | }
251 | }
252 | }
253 |
--------------------------------------------------------------------------------
/src/functions.php:
--------------------------------------------------------------------------------
1 | set_data( $item );
35 | return $entry;
36 | },
37 | $items
38 | );
39 | }
40 |
--------------------------------------------------------------------------------
/tests/TestDequeuer.php:
--------------------------------------------------------------------------------
1 | set_data( 'test 1' );
26 | $entry2 = ( new Entry() )->set_data( 'test 2' );
27 | $queue->enqueue( $entry1 );
28 | $queue->enqueue( $entry2 );
29 |
30 | $dequeued1 = $queue->dequeue();
31 | $dequeued2 = $queue->dequeue();
32 | $just_null = $queue->dequeue();
33 |
34 | $this->assertSame( $entry1->get_data(), $dequeued1->get_data() );
35 | $this->assertSame( $entry2->get_data(), $dequeued2->get_data() );
36 | $this->assertNull( $just_null );
37 | }
38 | }
--------------------------------------------------------------------------------
/tests/TestEnqueuer.php:
--------------------------------------------------------------------------------
1 | set_data( 'test 2' );
26 |
27 | $enqueuer = new Enqueuer();
28 | $enqueuer->enqueue( $queue, $entry );
29 |
30 | $this->assertEquals( 1, $queue->size() );
31 |
32 | $dequeued = $queue->dequeue();
33 |
34 | $this->assertSame( $entry, $dequeued );
35 | }
36 |
37 | public function test_fetch() {
38 | $test_data = 'test';
39 |
40 | $queue = new MockQueue(
41 | 'enqueue_test_2',
42 | new MockEntryFetcher( [ $test_data ] ),
43 | new MockEntryHandler()
44 | );
45 |
46 | $enqueuer = new Enqueuer();
47 | $enqueuer->fetch( $queue );
48 |
49 | $this->assertEquals( 1, $queue->size() );
50 |
51 | $dequeued = $queue->dequeue();
52 |
53 | $this->assertEquals( $test_data, $dequeued->get_data() );
54 | }
55 | }
--------------------------------------------------------------------------------
/tests/TestFunctions.php:
--------------------------------------------------------------------------------
1 | assertTrue( wpq() instanceof QueuePlugin );
16 | }
17 |
18 | public function test_wpq_wrap_items_to_entries() {
19 | $items = [ 1, 2, '3', (object) [ 'a' => 1 ] ];
20 |
21 | $entries = wpq_wrap_items_to_entries( $items );
22 |
23 | array_walk( $entries, function( $entry ) {
24 | $this->assertTrue( $entry instanceof EntryInterface );
25 | } );
26 | }
27 | }
--------------------------------------------------------------------------------
/tests/TestQueueContainer.php:
--------------------------------------------------------------------------------
1 | get_queue_container();
22 |
23 | $queue = new MockQueue(
24 | 'test1',
25 | new MockEntryFetcher( [] ),
26 | new MockEntryHandler()
27 | );
28 |
29 | $container->add( $queue );
30 |
31 | $this->assertTrue( $container->has( 'test1' ) );
32 | }
33 |
34 | /**
35 | * Test the add method.
36 | */
37 | public function test_container_add() {
38 | $plugin = wpq();
39 | $container = $plugin->get_queue_container();
40 |
41 | $queue = new MockQueue(
42 | 'test2',
43 | new MockEntryFetcher( [] ),
44 | new MockEntryHandler()
45 | );
46 |
47 | $container->add( $queue );
48 |
49 | $with_same_name = new MockQueue(
50 | 'test2',
51 | new MockEntryFetcher( [] ),
52 | new MockEntryHandler()
53 | );
54 |
55 | $container->add( $with_same_name );
56 |
57 | $current = $container->get( $queue->get_name() );
58 | $this->assertSame( $current, $queue );
59 | $this->assertNotSame( $current, $with_same_name );
60 | }
61 |
62 | /**
63 | * Test the get method.
64 | */
65 | public function test_container_get() {
66 | $plugin = wpq();
67 | $container = $plugin->get_queue_container();
68 |
69 | $first_queue = new MockQueue(
70 | 'test3',
71 | new MockEntryFetcher( [ 1, 2, 3 ] ),
72 | new MockEntryHandler()
73 | );
74 |
75 | $container->add( $first_queue );
76 |
77 | $second_queue = new MockQueue(
78 | 'test4',
79 | new MockEntryFetcher( [ 4, 5, 6 ] ),
80 | new MockEntryHandler()
81 | );
82 | $container->add( $second_queue );
83 |
84 | $get_first = $container->get( $first_queue->get_name() );
85 | $get_second = $container->get( $second_queue->get_name() );
86 |
87 | $this->assertSame( $first_queue, $get_first );
88 | $this->assertSame( $second_queue, $get_second );
89 | $this->assertNotSame( $first_queue, $get_second );
90 | $this->assertNotSame( $second_queue, $get_first );
91 | }
92 |
93 | /**
94 | * Test the replace method.
95 | */
96 | public function test_container_replace() {
97 | $plugin = wpq();
98 | $container = $plugin->get_queue_container();
99 |
100 | $replacable = new MockQueue(
101 | 'replacable',
102 | new MockEntryFetcher( [ 1, 2, 3 ] ),
103 | new MockEntryHandler()
104 | );
105 |
106 | $container->add( $replacable );
107 |
108 | $replace_with = new MockQueue(
109 | 'replacable',
110 | new MockEntryFetcher( [ 4, 5, 6 ] ),
111 | new MockEntryHandler()
112 | );
113 |
114 | $container->replace( $replace_with );
115 |
116 | $current = $container->get( 'replacable' );
117 |
118 | $this->assertSame( $replace_with, $current );
119 | $this->assertNotSame( $current, $replacable );
120 | }
121 | }
122 |
--------------------------------------------------------------------------------
/tests/TestQueueCreator.php:
--------------------------------------------------------------------------------
1 | create();
25 |
26 | $this->assertEquals( 2, $queue->size() );
27 | $this->assertTrue( $queue->is_saved() );
28 | }
29 |
30 | }
31 |
--------------------------------------------------------------------------------
/tests/TestRedisQueue.php:
--------------------------------------------------------------------------------
1 | assertTrue( true );
15 | }
16 |
17 | }
--------------------------------------------------------------------------------
/tests/bootstrap.php:
--------------------------------------------------------------------------------
1 | [
18 | 'Version' => '1.0.0-beta',
19 | ]
20 | ]
21 | );
22 |
23 | // Mock the plugin dir url.
24 | WP_Mock::userFunction( 'plugin_dir_url',
25 | [
26 | 'return' => '/wp-content/plugins/wp-queue'
27 | ]
28 | );
29 |
30 | // Replace the Redis instance with a mocked filter.
31 | $factory = new RedisMockFactory();
32 | $redis_mock_class = $factory->getAdapterClass( 'Predis\Client' );
33 | $redis_mock = new $redis_mock_class();
34 |
35 | \WP_Mock::onFilter( 'wpq_redis_instance' )
36 | ->with( null )
37 | ->reply( $redis_mock );
38 | }
39 | wp_mocks();
40 |
41 | add_filter( 'wqp_init_hook', function () { return null; } );
42 |
43 | require_once dirname( __DIR__ ) . '/plugin.php';
44 |
--------------------------------------------------------------------------------