From 4bae010110645fcadea46bb8b0bedb5b7ee9f013 Mon Sep 17 00:00:00 2001 From: Daniel Coull Date: Mon, 16 Jul 2018 15:36:06 +0100 Subject: [PATCH 1/7] upgrade: add cronjob --- .gitignore | 3 + Api/Jobs.php | 55 ++ Api/JobsInterface.php | 27 + Api/ProcessResponse.php | 41 ++ Api/ProcessResponseInterface.php | 23 + Console/Command/EnqueueCommand.php | 78 +++ Console/Command/ListCommand.php | 102 ++++ Console/Command/ProcessQueueCommand.php | 60 +++ Cron/Process.php | 51 ++ Helper/Data.php | 16 + LICENSE.md | 674 ++++++++++++++++++++++++ Model/Job.php | 60 +++ Model/Queue.php | 184 +++++++ Model/ResourceModel/Job.php | 16 + Model/ResourceModel/Job/Collection.php | 19 + README.md | 92 ++++ Setup/InstallSchema.php | 130 +++++ composer.json | 14 + etc/acl.xml | 11 + etc/config.xml | 12 + etc/crontab.xml | 9 + etc/di.xml | 14 + etc/module.xml | 6 + etc/webapi.xml | 18 + registration.php | 7 + 25 files changed, 1722 insertions(+) create mode 100644 .gitignore create mode 100644 Api/Jobs.php create mode 100644 Api/JobsInterface.php create mode 100644 Api/ProcessResponse.php create mode 100644 Api/ProcessResponseInterface.php create mode 100644 Console/Command/EnqueueCommand.php create mode 100644 Console/Command/ListCommand.php create mode 100644 Console/Command/ProcessQueueCommand.php create mode 100644 Cron/Process.php create mode 100644 Helper/Data.php create mode 100644 LICENSE.md create mode 100644 Model/Job.php create mode 100644 Model/Queue.php create mode 100644 Model/ResourceModel/Job.php create mode 100644 Model/ResourceModel/Job/Collection.php create mode 100644 README.md create mode 100644 Setup/InstallSchema.php create mode 100644 composer.json create mode 100644 etc/acl.xml create mode 100644 etc/config.xml create mode 100644 etc/crontab.xml create mode 100644 etc/di.xml create mode 100644 etc/module.xml create mode 100644 etc/webapi.xml create mode 100644 registration.php diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..d650569f --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.idea +.git +vendor \ No newline at end of file diff --git a/Api/Jobs.php b/Api/Jobs.php new file mode 100644 index 00000000..cd330536 --- /dev/null +++ b/Api/Jobs.php @@ -0,0 +1,55 @@ +queue = $queue; + parent::__construct($context, $registry); + } + + public function viewJobs() + { + return [ + 'jobs' => $this->queue->getCollection()->setPageSize(20)->toArray() + ]; + } + + public function process() + { + $result = $this->queue->process(); + if ($result === true) { + $message = "Job(s) run successfully"; + } elseif ($result === false) { + $message = "Job(s) failed"; + } else { + $message = "No jobs left to run"; + } + return new ProcessResponse($message, $this->queue->getCount()); + } +} diff --git a/Api/JobsInterface.php b/Api/JobsInterface.php new file mode 100644 index 00000000..5e4aefdb --- /dev/null +++ b/Api/JobsInterface.php @@ -0,0 +1,27 @@ +message = $message; + $this->count = $count; + } + + /** + * @return mixed + */ + public function getMessage() + { + return $this->message; + } + + /** + * @return mixed + */ + public function getCount() + { + return $this->count; + } + +} diff --git a/Api/ProcessResponseInterface.php b/Api/ProcessResponseInterface.php new file mode 100644 index 00000000..1322ec9e --- /dev/null +++ b/Api/ProcessResponseInterface.php @@ -0,0 +1,23 @@ +'; + const METHOD_ARGUMENT = ''; + const PRIORITY_ARGUMENT = ''; + const QUEUE_ARGUMENT = ''; + const PARAMS_ARGUMENT = ''; + + private $_queue; + + /** + * @param State $state + * @param Queue $queue + */ + public function __construct(State $state, Queue $queue) + { + $this->_queue = $queue; + parent::__construct(); + } + + /** + * Sets config for cli command + */ + protected function configure() + { + $this->setName('springbot:queue:enqueue') + ->setDescription('Enqueue Job') + ->addArgument(self::CLASS_ARGUMENT, InputArgument::REQUIRED) + ->addArgument(self::METHOD_ARGUMENT, InputArgument::REQUIRED) + ->addArgument(self::QUEUE_ARGUMENT, null, '', 'default') + ->addArgument(self::PRIORITY_ARGUMENT, null, '', 1) + ->addArgument(self::PARAMS_ARGUMENT, InputArgument::IS_ARRAY); + } + + /** + * @param InputInterface $input + * @param OutputInterface $output + * + * @return string + */ + protected function execute(InputInterface $input, OutputInterface $output) + { + try { + $successful = $this->_queue->scheduleJob( + $input->getArgument(self::CLASS_ARGUMENT), + $input->getArgument(self::METHOD_ARGUMENT), + $input->getArgument(self::PARAMS_ARGUMENT), + $input->getArgument(self::PRIORITY_ARGUMENT), + $input->getArgument(self::QUEUE_ARGUMENT) + ); + if ($successful) { + $output->writeln("Job enqueued. " . $input->getArgument(self::CLASS_ARGUMENT)); + } + else { + $output->writeln("Job not enqueued."); + } + } catch (\Exception $e) { + $output->writeln("Failed to enqueue job: " . $e->getMessage()); + } + } +} diff --git a/Console/Command/ListCommand.php b/Console/Command/ListCommand.php new file mode 100644 index 00000000..0c01201d --- /dev/null +++ b/Console/Command/ListCommand.php @@ -0,0 +1,102 @@ +'; + const PER_PAGE_ARGUMENT = ''; + const QUEUE_ARGUMENT = ''; + + private $_jobCollection; + + /** + * @param State $state + * @param Queue $queue + * @param JobCollection $jobCollection + */ + public function __construct(State $state, Queue $queue, JobCollection $jobCollection) + { + $this->_queue = $queue; + $this->_jobCollection = $jobCollection; + parent::__construct(); + } + + /** + * Sets config for cli command + */ + protected function configure() + { + $this->setName('springbot:queue:list') + ->setDescription('List jobs currently in the queue') + ->addArgument(self::PAGE_ARGUMENT, InputArgument::OPTIONAL, 'Page number', 1) + ->addArgument(self::PER_PAGE_ARGUMENT, InputArgument::OPTIONAL, 'Results per page', 25) + ->addArgument(self::QUEUE_ARGUMENT, InputArgument::OPTIONAL, 'Specify a specific queue'); + } + + /** + * @param InputInterface $input + * @param OutputInterface $output + * + * @return string + */ + protected function execute(InputInterface $input, OutputInterface $output) + { + $headers = ['queue', 'class', 'method', 'args', 'priority', 'attempts', 'error']; + $this->_jobCollection->setCurPage($input->getArgument(self::PAGE_ARGUMENT)); + $this->_jobCollection->setPageSize($input->getArgument(self::PER_PAGE_ARGUMENT)); + $this->_jobCollection->addOrder('priority', JobCollection::SORT_ORDER_ASC); + $this->_jobCollection->addOrder('next_run_at', JobCollection::SORT_ORDER_ASC); + + if ($queue = $input->getArgument(self::QUEUE_ARGUMENT)) { + $this->_jobCollection->addFieldToFilter('queue', $queue); + } + $jobs = $this->_jobCollection->toArray(); + + // Pre-calculate the max column widths + $maxWidths = []; + foreach ($headers as $header) { + $maxWidths[$header] = strlen($header) + 2; + } + foreach ($jobs['items'] as $job) { + foreach ($headers as $header) { + $newLength = strlen($job[$header]) + 2; + if ($newLength > $maxWidths[$header]) { + $maxWidths[$header] = $newLength; + } + } + } + $maxWidths = array_values($maxWidths); + + $table = new TextTable([ + 'columnWidths' => $maxWidths, + 'decorator' => 'ascii', + 'AutoSeparate' => TextTable::AUTO_SEPARATE_HEADER, + 'padding' => 1 + ]); + + $table->appendRow($headers); + foreach ($jobs['items'] as $job) { + $rowArr = []; + foreach ($headers as $header) { + $rowArr[$header] = $job[$header]; + } + $table->appendRow($rowArr); + } + $output->writeln($table->render()); + } +} diff --git a/Console/Command/ProcessQueueCommand.php b/Console/Command/ProcessQueueCommand.php new file mode 100644 index 00000000..1a134fe4 --- /dev/null +++ b/Console/Command/ProcessQueueCommand.php @@ -0,0 +1,60 @@ +_state = $state; + $this->_queue = $queue; + parent::__construct(); + } + + /** + * Sets config for cli command + */ + protected function configure() + { + $this->setName('springbot:queue:process') + ->setDescription('Process Queue'); + } + + /** + * @param InputInterface $input + * @param OutputInterface $output + * + * @return string + */ + protected function execute(InputInterface $input, OutputInterface $output) + { + $this->_state->setAreaCode(\Magento\Framework\App\Area::AREA_FRONTEND); + $success = $this->_queue->runNextJob(); + if ($success === true) { + $output->writeln("Queue Processed."); + } elseif ($success === false) { + $output->writeln("Job failed."); + } else { + $output->writeln("No jobs in queue."); + } + } +} diff --git a/Cron/Process.php b/Cron/Process.php new file mode 100644 index 00000000..d0072433 --- /dev/null +++ b/Cron/Process.php @@ -0,0 +1,51 @@ +_state = $state; + $this->_queue = $queue; + parent::__construct(); + } + + /** + * @param InputInterface $input + * @param OutputInterface $output + * + * @return string + */ + protected function execute(InputInterface $input, OutputInterface $output) + { + $this->_state->setAreaCode(\Magento\Framework\App\Area::AREA_FRONTEND); + $success = $this->_queue->runNextJob(); + if ($success === true) { + $output->writeln("Queue Processed."); + } elseif ($success === false) { + $output->writeln("Job failed."); + } else { + $output->writeln("No jobs in queue."); + } + } +} \ No newline at end of file diff --git a/Helper/Data.php b/Helper/Data.php new file mode 100644 index 00000000..4b419ef7 --- /dev/null +++ b/Helper/Data.php @@ -0,0 +1,16 @@ + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Model/Job.php b/Model/Job.php new file mode 100644 index 00000000..89476eb3 --- /dev/null +++ b/Model/Job.php @@ -0,0 +1,60 @@ +_init('Springbot\Queue\Model\ResourceModel\Job'); + $this->_objectManager = $objectManager; + parent::__construct($context, $registry); + } + + public function run() + { + $class = $this->getData('class'); + $method = $this->getData('method'); + $args = json_decode($this->getData('args'), true); + if (class_exists($class)) { + $object = $this->_objectManager->get($class); + if (method_exists($object, $method)) { + return call_user_func_array([$object, $method], $args); + } else { + throw new Exception("Method {$method} does not exist in class {$class}"); + } + } else { + throw new Exception("Class {$class} does not exist"); + } + } + + public function setNextRunAt() + { + $this->setData('run_at', $this->_calculateNextRunAt()); + } + + protected function _calculateNextRunAt() + { + $attempts = $this->getAttempts(); + $expMinutes = pow(2, $attempts); + $nextRun = date("Y-m-d H:i:s", strtotime("+$expMinutes minutes")); + return $nextRun; + } +} diff --git a/Model/Queue.php b/Model/Queue.php new file mode 100644 index 00000000..65069a2d --- /dev/null +++ b/Model/Queue.php @@ -0,0 +1,184 @@ +_init('Springbot\Queue\Model\ResourceModel\Job'); + $this->jobFactory = $jobFactory; + $this->jobCollection = $jobCollection; + $this->scopeConfig = $scopeConfigInterface; + parent::__construct($context, $registry); + } + + /** + * @param $class + * @param $method + * @param array $args + * @param string $queue + * @param $priority + * @param $time + * @return boolean + */ + public function scheduleJob( + $class, + $method, + array $args, + $priority = 1, + $queue = 'default', + $time = null + ) { + try { + $hash = sha1($method . json_encode($args)); + if ($this->jobExists($hash)) { + return false; + } + else { + if ($time) { + $nextRunAt = date("Y-m-d H:i:s", strtotime($time)); + } + else { + $nextRunAt = date("Y-m-d H:i:s"); + } + $jobModel = $this->jobFactory->create(); + $jobModel->addData([ + 'method' => $method, + 'args' => json_encode($args), + 'class' => $class, + 'hash' => $hash, + 'queue' => $queue, + 'priority' => $priority, + 'next_run_at' => $nextRunAt + ]); + $jobModel->save(); + return true; + } + } catch (\Exception $e) { + $this->_logger->debug("Failed to enqueue job: " . $e->getMessage()); + return false; + } + } + + public function jobExists($hash) + { + $collection = $this->jobCollection->addFieldToFilter('hash', $hash); + $item = $collection->getFirstItem(); + return (!$item->isEmpty()); + } + + public function getNextJob() + { + $nextJob = $this->getRunnableJobs() + ->setOrder('priority', Collection::SORT_ORDER_ASC) + ->addOrder('id', Collection::SORT_ORDER_ASC) + ->setPageSize(1) + ->setCurPage(1) + ->getFirstItem(); + if (!$nextJob->isEmpty()) { + return $nextJob; + } + else { + return null; + } + } + + /** + * @return bool|null + */ + public function runNextJob() + { + if ($nextJob = $this->getNextJob()) { + try { + $nextJob->run(); + $nextJob->delete(); + return true; + } catch (Exception $e) { + $attempts = $nextJob->getData('attempts'); + $attempts = (!$attempts) ? 0 : $attempts; + $attempts++; + $nextJob->setData('error', $e->getMessage()); + $nextJob->setData('attempts', $attempts); + $nextJob->setNextRunAt(); + $nextJob->save(); + return false; + } + } + else { + return null; + } + } + + /** + * Process the next N jobs in the queue where N is the max_jobs value + * + * @return bool|null + */ + public function process() + { + $maxJobs = $this->scopeConfig->getValue('springbot/queue/max_jobs'); + if (!is_numeric($maxJobs)) { + $maxJobs = 1; + } + + for ($i = 1; $i <= $maxJobs; $i++) { + if ($this->runNextJob() === null) { + return null; + } + } + return true; + } + + /** + * @return int + */ + public function getCount() + { + return $this->getRunnableJobs() + ->count(); + } + + /** + * @return JobCollection + */ + private function getRunnableJobs() + { + $this->jobCollection->clear(); + return $this->jobCollection + ->addFieldToFilter( + ['next_run_at', 'next_run_at'], + [['lteq' => date("Y-m-d H:i:s")], ['null' => 'null']] + ) + ->addFieldToFilter( + ['attempts', 'attempts'], + [['lt' => 10], ['null' => 'null']] + ) + ->setPageSize(20); + } + +} diff --git a/Model/ResourceModel/Job.php b/Model/ResourceModel/Job.php new file mode 100644 index 00000000..d0ce362a --- /dev/null +++ b/Model/ResourceModel/Job.php @@ -0,0 +1,16 @@ +_init('springbot_queue', 'id'); + } +} diff --git a/Model/ResourceModel/Job/Collection.php b/Model/ResourceModel/Job/Collection.php new file mode 100644 index 00000000..8e1b0aee --- /dev/null +++ b/Model/ResourceModel/Job/Collection.php @@ -0,0 +1,19 @@ +_init( + 'Springbot\Queue\Model\Job', + 'Springbot\Queue\Model\ResourceModel\Job' + ); + } +} diff --git a/README.md b/README.md new file mode 100644 index 00000000..e8fac947 --- /dev/null +++ b/README.md @@ -0,0 +1,92 @@ +[![GPL licensed](https://img.shields.io/badge/license-GPL-blue.svg)](https://raw.githubusercontent.com/springbot/magento2-queue/master/LICENSE.md) + +## Magento2 Job Queue + +This module provides functionality to schedule and run jobs in a queue for Magento2. The basic idea is to allow +developers to defer tasks that would otherwise delay the page load time and cause site slowness. Example use cases may +be sending an email, communicating with a remote API, or running cleanup tasks in the background. + +While originally written for our Springbot Magento2 integration, this module can be utilized for many other use cases. + +The module provides both programmatic and command line ways to enqueue, run, and view jobs. The key components of a job +are a fully qualified class name, a method name, and a list of arguments. There are a few requirements: the class must +be autoloadable, the method must be public, and the params must not contain objects. Additional options are priority, +queue name, and "run at" time. + +### Installation + +Composer is the preferred method of installation: +```bash +composer require springbot/magento2-queue +php bin/magento module:enable Springbot_Queue +``` + +### Command line usage + +Enqueue a job +```bash + php bin/magento springbot:queue:enqueue [] [] [1] ... [N] +``` + +List current jobs in the queue +```bash + php bin/magento springbot:queue:list +``` + +Process the queue +```bash +php bin/magento springbot:queue:process +``` + +### Programmatic usage + +```php +queue = $queue; + } + + /** + * Queue examples + */ + public function runQueueExamples() + { + // Enqueue a job + $this->queue->scheduleJob('\Fully\Qualified\ClassName', 'methodToRun', ['arg1', 'arg2']); + + // Process the queue + $this->queue->runNextJob(); + + // Get a collection of current jobs + $jobs = $this->queue->getCollection(); + } +} +``` + +### API Usage + +To process the queue make a GET request to the following API endpoint: +``` +/V1/springbot/queue/process +``` + +To view current jobs make a GET request to the following API endpoint: +``` +/V1/springbot/queue/jobs +``` + +For security purposes jobs cannot be enqueued directly from the web API. \ No newline at end of file diff --git a/Setup/InstallSchema.php b/Setup/InstallSchema.php new file mode 100644 index 00000000..ab2d27a8 --- /dev/null +++ b/Setup/InstallSchema.php @@ -0,0 +1,130 @@ +startSetup(); + + /** + * Create table 'springbot_queue' + */ + $connection = $installer->getConnection(); + $table = $connection->newTable( + $installer->getTable('springbot_queue')) + ->addColumn( + 'id', + Table::TYPE_INTEGER, + 11, + ['identity' => true, 'unsigned' => true, 'nullable' => false, 'primary' => true], + 'ID') + ->addColumn( + 'method', + Table::TYPE_TEXT, + null, + ['nullable' => false], + 'Queue method') + ->addColumn( + 'args', + Table::TYPE_TEXT, + null, + ['nullable' => false], + 'Type ID') + ->addColumn( + 'class', + Table::TYPE_TEXT, + null, + ['nullable' => false], + 'Class To Instantiate') + ->addColumn( + 'hash', + Table::TYPE_TEXT, + 40, + ['nullable' => false], + 'Has options') + ->addColumn( + 'queue', + Table::TYPE_TEXT, + 255, + ['nullable' => false], + 'Required options') + ->addColumn( + 'priority', + Table::TYPE_INTEGER, + 10, + [], + 'Queue priority') + ->addColumn( + 'attempts', + Table::TYPE_INTEGER, + 10, + [], + 'Attempts to run queue') + ->addColumn( + 'run_at', + Table::TYPE_DATETIME, + null, + [], + 'Initial run time') + ->addColumn( + 'locked_at', + Table::TYPE_DATETIME, + null, + [], + 'Locked at time') + ->addColumn( + 'locked_by', + Table::TYPE_TEXT, + 255, + [], + 'Locked by pid') + ->addColumn( + 'error', + Table::TYPE_TEXT, + null, + [], + 'Next run time') + ->addColumn( + 'next_run_at', + Table::TYPE_DATETIME, + null, + [], + 'Next run time') + ->addColumn( + 'created_at', + Table::TYPE_DATETIME, + null, + [], + 'Next run time') + ->setComment('Springbot Queue Table'); + $installer->getConnection()->createTable($table); + + $connection->addIndex( + $setup->getTable('springbot_queue'), + $setup->getIdxName('springbot_queue', ['next_run_at']), + ['next_run_at'] + ); + + $connection->addIndex( + $setup->getTable('springbot_queue'), + $setup->getIdxName('springbot_queue', ['attempts']), + ['attempts'] + ); + + $connection->addIndex( + $setup->getTable('springbot_queue'), + $setup->getIdxName('springbot_queue', ['priority']), + ['priority'] + ); + + $installer->endSetup(); + } +} diff --git a/composer.json b/composer.json new file mode 100644 index 00000000..7e910185 --- /dev/null +++ b/composer.json @@ -0,0 +1,14 @@ +{ + "name": "springbot/magento2-queue", + "description": "A generic job queuing package for Magento 2", + "type": "magento2-module", + "license": [ + "OSL-3.0" + ], + "autoload": { + "files": [ "registration.php" ], + "psr-4": { + "Springbot\\Queue\\": "" + } + } +} \ No newline at end of file diff --git a/etc/acl.xml b/etc/acl.xml new file mode 100644 index 00000000..179ab5e1 --- /dev/null +++ b/etc/acl.xml @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/etc/config.xml b/etc/config.xml new file mode 100644 index 00000000..f702822c --- /dev/null +++ b/etc/config.xml @@ -0,0 +1,12 @@ + + + + + + + 1 + + + + diff --git a/etc/crontab.xml b/etc/crontab.xml new file mode 100644 index 00000000..4b56994c --- /dev/null +++ b/etc/crontab.xml @@ -0,0 +1,9 @@ + + + + + */15 * * * * + + + + diff --git a/etc/di.xml b/etc/di.xml new file mode 100644 index 00000000..b7ea8e83 --- /dev/null +++ b/etc/di.xml @@ -0,0 +1,14 @@ + + + + + + + Springbot\Queue\Console\Command\ProcessQueueCommand + Springbot\Queue\Console\Command\EnqueueCommand + Springbot\Queue\Console\Command\ListCommand + + + + + diff --git a/etc/module.xml b/etc/module.xml new file mode 100644 index 00000000..8d5c403a --- /dev/null +++ b/etc/module.xml @@ -0,0 +1,6 @@ + + + + + diff --git a/etc/webapi.xml b/etc/webapi.xml new file mode 100644 index 00000000..531258b5 --- /dev/null +++ b/etc/webapi.xml @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + + diff --git a/registration.php b/registration.php new file mode 100644 index 00000000..d146f1cd --- /dev/null +++ b/registration.php @@ -0,0 +1,7 @@ + Date: Fri, 26 Oct 2018 23:29:45 +0000 Subject: [PATCH 2/7] fix to cron process --- Cron/Process.php | 3 +-- etc/config.xml | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/Cron/Process.php b/Cron/Process.php index d0072433..d972b64a 100644 --- a/Cron/Process.php +++ b/Cron/Process.php @@ -27,7 +27,6 @@ public function __construct(State $state, Queue $queue) { $this->_state = $state; $this->_queue = $queue; - parent::__construct(); } /** @@ -48,4 +47,4 @@ protected function execute(InputInterface $input, OutputInterface $output) $output->writeln("No jobs in queue."); } } -} \ No newline at end of file +} diff --git a/etc/config.xml b/etc/config.xml index f702822c..5abe46e1 100644 --- a/etc/config.xml +++ b/etc/config.xml @@ -5,7 +5,7 @@ - 1 + 50 From a7a607cfa81af084a814a33284bec259d786db6f Mon Sep 17 00:00:00 2001 From: Your Name Date: Mon, 29 Oct 2018 09:47:46 +0000 Subject: [PATCH 3/7] changes --- Console/Command/ProcessQueueCommand.php | 2 +- Cron/Process.php | 2 +- Model/Queue.php | 8 ++------ etc/config.xml | 2 +- 4 files changed, 5 insertions(+), 9 deletions(-) diff --git a/Console/Command/ProcessQueueCommand.php b/Console/Command/ProcessQueueCommand.php index bebacd85..548b5332 100644 --- a/Console/Command/ProcessQueueCommand.php +++ b/Console/Command/ProcessQueueCommand.php @@ -54,7 +54,7 @@ protected function execute(InputInterface $input, OutputInterface $output) $this->_state->setAreaCode(\Magento\Framework\App\Area::AREA_FRONTEND); - $success = $this->_queue->runNextJob(); + $success = $this->_queue->process(); if ($success === true) { $output->writeln("Queue Processed."); } elseif ($success === false) { diff --git a/Cron/Process.php b/Cron/Process.php index d0072433..34b280f5 100644 --- a/Cron/Process.php +++ b/Cron/Process.php @@ -39,7 +39,7 @@ public function __construct(State $state, Queue $queue) protected function execute(InputInterface $input, OutputInterface $output) { $this->_state->setAreaCode(\Magento\Framework\App\Area::AREA_FRONTEND); - $success = $this->_queue->runNextJob(); + $success = $this->_queue->process(); if ($success === true) { $output->writeln("Queue Processed."); } elseif ($success === false) { diff --git a/Model/Queue.php b/Model/Queue.php index 798665af..41463ddf 100644 --- a/Model/Queue.php +++ b/Model/Queue.php @@ -178,14 +178,10 @@ public function runNextJob() public function process() { $maxJobs = $this->scopeConfig->getValue('springbot/queue/max_jobs'); - if (!is_numeric($maxJobs)) { - $maxJobs = 1; - } + $maxJobs=20; for ($i = 1; $i <= $maxJobs; $i++) { - if ($this->runNextJob() === null) { - return null; - } + $this->runNextJob(); } return true; } diff --git a/etc/config.xml b/etc/config.xml index f702822c..5abe46e1 100644 --- a/etc/config.xml +++ b/etc/config.xml @@ -5,7 +5,7 @@ - 1 + 50 From c43a65298ce408cf0e5a847d73f4e26b291ad328 Mon Sep 17 00:00:00 2001 From: Your Name Date: Mon, 29 Oct 2018 14:28:50 +0000 Subject: [PATCH 4/7] change protected cron to public2 --- Cron/Process.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cron/Process.php b/Cron/Process.php index 11091a1d..65b780eb 100644 --- a/Cron/Process.php +++ b/Cron/Process.php @@ -35,7 +35,7 @@ public function __construct(State $state, Queue $queue) * * @return string */ - protected function execute(InputInterface $input, OutputInterface $output) + public function execute(InputInterface $input, OutputInterface $output) { $this->_state->setAreaCode(\Magento\Framework\App\Area::AREA_FRONTEND); $success = $this->_queue->process(); From d34a057c923be13d8de65a36374dea4682e6f38f Mon Sep 17 00:00:00 2001 From: Daniel Coull Date: Tue, 30 Oct 2018 11:00:31 +0000 Subject: [PATCH 5/7] fix issues with cron --- Cron/Process.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cron/Process.php b/Cron/Process.php index 65b780eb..04325c66 100644 --- a/Cron/Process.php +++ b/Cron/Process.php @@ -35,7 +35,7 @@ public function __construct(State $state, Queue $queue) * * @return string */ - public function execute(InputInterface $input, OutputInterface $output) + public function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) { $this->_state->setAreaCode(\Magento\Framework\App\Area::AREA_FRONTEND); $success = $this->_queue->process(); From f6695f00eaa6ba80d8551bb0af769676b29eab27 Mon Sep 17 00:00:00 2001 From: Daniel Coull Date: Tue, 30 Oct 2018 15:10:07 +0000 Subject: [PATCH 6/7] changes --- Cron/Process.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Cron/Process.php b/Cron/Process.php index 04325c66..fd8b2046 100644 --- a/Cron/Process.php +++ b/Cron/Process.php @@ -35,9 +35,9 @@ public function __construct(State $state, Queue $queue) * * @return string */ - public function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) + public function execute() { - $this->_state->setAreaCode(\Magento\Framework\App\Area::AREA_FRONTEND); + //$this->_state->setAreaCode(\Magento\Framework\App\Area::AREA_FRONTEND); $success = $this->_queue->process(); if ($success === true) { $output->writeln("Queue Processed."); From 73d65164d4761fab4b903bcd1f01032d38ec9e29 Mon Sep 17 00:00:00 2001 From: Daniel Coull Date: Tue, 13 Nov 2018 14:46:39 +0000 Subject: [PATCH 7/7] changes --- Cron/Process.php | 7 ------- Model/Queue.php | 2 +- etc/config.xml | 2 +- etc/crontab.xml | 2 +- 4 files changed, 3 insertions(+), 10 deletions(-) diff --git a/Cron/Process.php b/Cron/Process.php index fd8b2046..83802985 100644 --- a/Cron/Process.php +++ b/Cron/Process.php @@ -39,12 +39,5 @@ public function execute() { //$this->_state->setAreaCode(\Magento\Framework\App\Area::AREA_FRONTEND); $success = $this->_queue->process(); - if ($success === true) { - $output->writeln("Queue Processed."); - } elseif ($success === false) { - $output->writeln("Job failed."); - } else { - $output->writeln("No jobs in queue."); - } } } diff --git a/Model/Queue.php b/Model/Queue.php index 41463ddf..487b6746 100644 --- a/Model/Queue.php +++ b/Model/Queue.php @@ -178,7 +178,7 @@ public function runNextJob() public function process() { $maxJobs = $this->scopeConfig->getValue('springbot/queue/max_jobs'); - $maxJobs=20; + $maxJobs=500; for ($i = 1; $i <= $maxJobs; $i++) { $this->runNextJob(); diff --git a/etc/config.xml b/etc/config.xml index 5abe46e1..c8899796 100644 --- a/etc/config.xml +++ b/etc/config.xml @@ -5,7 +5,7 @@ - 50 + 100 diff --git a/etc/crontab.xml b/etc/crontab.xml index 4b56994c..c6e87520 100644 --- a/etc/crontab.xml +++ b/etc/crontab.xml @@ -2,7 +2,7 @@ - */15 * * * * + */5 * * * *