├── .gitignore ├── ExecutorGrailsPlugin.groovy ├── LICENSE.txt ├── README.md ├── application.properties ├── grails-app ├── conf │ ├── BuildConfig.groovy │ ├── Config.groovy │ └── DataSource.groovy ├── controllers │ └── grails │ │ └── plugin │ │ └── executor │ │ └── TestController.groovy ├── domain │ └── executor │ │ └── test │ │ └── Book.groovy └── services │ └── grails │ └── plugin │ └── executor │ └── TestService.groovy ├── src └── groovy │ └── grails │ └── plugin │ └── executor │ ├── PersistenceContextCallableWrapper.groovy │ ├── PersistenceContextExecutorWrapper.groovy │ ├── PersistenceContextRunnableWrapper.groovy │ └── PersistenceContextWrapper.groovy └── test └── integration └── grails └── plugin └── executor ├── AlternativeSyntaxesSpec.groovy ├── DynamicMethodsSpec.groovy └── PersistenceExecutorServiceTests.groovy /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | stacktrace.log 3 | /*.zip 4 | /plugin.xml 5 | /web-app 6 | -------------------------------------------------------------------------------- /ExecutorGrailsPlugin.groovy: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2011 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | import grails.plugin.executor.PersistenceContextExecutorWrapper 18 | 19 | import java.util.concurrent.Executors 20 | 21 | class ExecutorGrailsPlugin { 22 | 23 | def version = "0.3" 24 | def grailsVersion = "1.2 > *" 25 | 26 | def author = "Joshua Burnett" 27 | def authorEmail = "joshua@greenbill.com" 28 | def title = "Concurrency / asynchronous /background process plugin" 29 | def description = "its all concurrent baby." 30 | def documentation = "http://github.com/basejump/grails-executor" 31 | 32 | def license = 'APACHE' 33 | def issueManagement = [system: 'GITHUB', url: 'https://github.com/basejump/grails-executor/issues'] 34 | def scm = [url: 'https://github.com/basejump/grails-executor'] 35 | 36 | def observe = ["controllers","services"] 37 | 38 | def pluginExcludes = [ 39 | "grails-app/**", 40 | "web-app/**" 41 | ] 42 | 43 | def doWithSpring = { 44 | executorService(PersistenceContextExecutorWrapper) { bean -> 45 | bean.destroyMethod = 'destroy' 46 | persistenceInterceptor = ref("persistenceInterceptor") 47 | executor = Executors.newCachedThreadPool() 48 | } 49 | } 50 | 51 | def addAsyncMethods(application, clazz) { 52 | clazz.metaClass.runAsync = { Runnable runme -> 53 | application.mainContext.executorService.withPersistence(runme) 54 | } 55 | clazz.metaClass.callAsync = { Closure clos -> 56 | application.mainContext.executorService.withPersistence(clos) 57 | } 58 | clazz.metaClass.callAsync = { Runnable runme, returnval -> 59 | application.mainContext.executorService.withPersistence(runme, returnval) 60 | } 61 | } 62 | 63 | def doWithDynamicMethods = { ctx -> 64 | for (artifactClasses in [application.controllerClasses, application.serviceClasses, application.domainClasses]) { 65 | for (clazz in artifactClasses) { 66 | addAsyncMethods(application, clazz) 67 | } 68 | } 69 | } 70 | 71 | def onChange = { event -> 72 | if (application.isControllerClass(event.source) || application.isServiceClass(event.source)) { 73 | addAsyncMethods(application, event.source) 74 | } 75 | } 76 | } 77 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Summary 2 | -------- 3 | 4 | This grails plugin incorporates the java concurrency Executor Framework into a plugin so your grails app can take advantage of asynchronous (background thread / concurrent) processing. The main need for this as opposed to just using an [ExecutorService][] from [Executors][] is that we need to wrap the calls so there is a Hibernate or other Data provider session bound to the thread. 5 | This uses the following pattern to wrap Runnable/Closures so they get a session for whatever Gorm you are using. Hibernate being the default but this is also tested with Mongo (no heavily) See the info on the [PersistenceContextInterceptor][] grails bean for more info 6 | 7 | //injected spring bean 8 | PersistenceContextInterceptor persistenceInterceptor 9 | 10 | protected wrap(Closure wrapped) { 11 | persistenceInterceptor.init() 12 | try { 13 | wrapped() 14 | } finally { 15 | persistenceInterceptor.flush() 16 | persistenceInterceptor.destroy() 17 | } 18 | } 19 | 20 | Here are a couple of links to get give you some background information. 21 | 22 | 23 | 24 | 25 | and here are few good write up on groovy concurrency 26 | 27 | and a slide show 28 | 29 | 30 | Setup 31 | ------- 32 | 33 | The plugin sets up a Grails service bean called executorService so you need do nothing really. It delegates to an implementation of an Java [ExecutorService][] (not to be confused with a Grails Service) interface so read up on that for more info on what you can do with the executorService. It basically wraps another thread pool [ExecutorService][]. By default it uses the java [Executors][] utility class to setup the injected thread pool ExecutorService implementation. The default Grails executorService config looks like this 34 | 35 | executorService( grails.plugin.executor.PersistenceContextExecutorWrapper ) { bean-> 36 | bean.destroyMethod = 'destroy' 37 | persistenceInterceptor = ref("persistenceInterceptor") 38 | executor = Executors.newCachedThreadPool() 39 | } 40 | 41 | You can override it and inject your own special thread pool executor using [Executors][] by overriding the bean in conf/spring/resources.groovy or the doWithSpring closure in your plugin. 42 | 43 | executorService( grails.plugin.executor.PersistenceContextExecutorWrapper ) { bean-> 44 | bean.destroyMethod = 'destroy' //keep this destroy method so it can try and clean up nicely 45 | persistenceInterceptor = ref("persistenceInterceptor") 46 | //this can be whatever from Executors (don't write your own and pre-optimize) 47 | executor = Executors.newCachedThreadPool(new YourSpecialThreadFactory()) 48 | } 49 | 50 | Usage 51 | ------ 52 | 53 | You can inject the executorService into any bean. Its a [PersistenceContextExecutorWrapper][] that delegates any calls to a concrete [ExecutorService][] implementation so, again, see the api for more on what you can do. Remember that a [Closure][] is a [Runnable][] so you can pass it to any of the methods that accept a runnable. A great example exists [here on the groovy site](http://groovy.codehaus.org/Concurrency+with+Groovy) 54 | 55 | The plugin adds shortcut methods to any service/controller/domain artifacts. 56 | 57 | - **runAsync _closure_** - takes any closure and passes it through to the executorService.execute 58 | - **callAsync _closure_** - takes any closure that returns a value and passes it through to the executorService.submit . You will get a [Future] back that you can work with. This will not bind a session in java 1.5 and only works on 1.6 or later 59 | 60 | NOTE ON TRANSACTIONS: keep in mind that this is spinning off a new thread and that any call will be outside of the transaction you are in. Use .withTransaction inside your closure, runnable or callable to make your process run in a transaction that is not calling a transactional service method (such as when using this in a controller). 61 | 62 | Examples 63 | -------- 64 | 65 | in a service/domain/controller just pass a Closure or [Runnable] to runAsync 66 | 67 | class someService { 68 | 69 | def myMethod(){ 70 | ..do some stuff 71 | runAsync { 72 | //this will be in its own trasaction 73 | //since each of these service methods are Transactional 74 | calcAging() 75 | } 76 | .. do some other stuff while aging is calced in background 77 | } 78 | 79 | def calcAging(){ 80 | ...do long process 81 | } 82 | } 83 | 84 | or inject the executorService 85 | 86 | class someService { 87 | def executorService 88 | 89 | def myMethod(){ 90 | ....do stuff 91 | def future = executorService.submit({ 92 | return calcAging() //you can of course leave out the "return" here 93 | } as Callable) 94 | .. do some other stuff while its processing 95 | //now block and wait with get() 96 | def aging = future.get() 97 | ..do something 98 | } 99 | 100 | def calcAging(){ 101 | ...do long process 102 | return agingCalcObject 103 | } 104 | 105 | } 106 | 107 | or during a domain event 108 | 109 | class Book { 110 | def myNotifyService 111 | 112 | String name 113 | 114 | def afterInsert(){ 115 | runAsync { 116 | myNotifyService.informLibraryOfCongress(this) 117 | } 118 | } 119 | } 120 | 121 | the callAsync allows you to spin of a process and calls the underlying executorService submit 122 | 123 | class someService { 124 | def myMethod(){ 125 | ....do stuff 126 | def future = callAsync { 127 | return calcAging() //you can of course leave out the "return" here 128 | } 129 | .. do some other stuff while its processing 130 | //now block and wait with get() 131 | def aging = future.get() 132 | ..do something with the aging 133 | } 134 | 135 | def calcAging(){ 136 | ...do stuff 137 | return agingCalcObject 138 | } 139 | } 140 | 141 | TODOs 142 | -------- 143 | 144 | * TODO - setup a wrapper so we can use a [ScheduledExecutorService][] too. 145 | 146 | 147 | [ExecutorService]: http://download.oracle.com/javase/6/docs/api/java/util/concurrent/ExecutorService.html 148 | [Executors]: http://download.oracle.com/javase/6/docs/api/java/util/concurrent/Executors.html 149 | [Future]: http://download-llnw.oracle.com/javase/6/docs/api/java/util/concurrent/Future.html 150 | [Runnable]: http://download.oracle.com/javase/6/docs/api/java/lang/Runnable.html 151 | [Closure]: http://groovy.codehaus.org/api/groovy/lang/Closure.html 152 | [ScheduledExecutorService]: http://download.oracle.com/javase/6/docs/api/java/util/concurrent/ScheduledExecutorService.html 153 | [PersistenceContextExecutorWrapper]: http://github.com/basejump/grails-executor/blob/master/src/groovy/grails/plugin/executor/PersistenceContextExecutorWrapper.groovy 154 | [PersistenceContextInterceptor]: http://grails.org/doc/latest/api/org/codehaus/groovy/grails/support/PersistenceContextInterceptor.html 155 | -------------------------------------------------------------------------------- /application.properties: -------------------------------------------------------------------------------- 1 | app.grails.version=2.2.3 2 | -------------------------------------------------------------------------------- /grails-app/conf/BuildConfig.groovy: -------------------------------------------------------------------------------- 1 | grails.project.work.dir = 'target' 2 | 3 | grails.project.dependency.resolution = { 4 | 5 | inherits 'global' 6 | log 'warn' 7 | 8 | repositories { 9 | grailsCentral() 10 | mavenLocal() 11 | mavenCentral() 12 | } 13 | 14 | dependencies { 15 | test 'org.spockframework:spock-grails-support:0.7-groovy-2.0' 16 | } 17 | 18 | plugins { 19 | build ':release:2.2.1', ':rest-client-builder:1.0.3', { 20 | export = false 21 | } 22 | 23 | test ":hibernate:$grailsVersion", { 24 | export = false 25 | } 26 | 27 | test ':spock:0.7', { 28 | exclude 'spock-grails-support' 29 | export = false 30 | } 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /grails-app/conf/Config.groovy: -------------------------------------------------------------------------------- 1 | log4j = { 2 | error 'org.codehaus.groovy.grails', 3 | 'org.springframework', 4 | 'org.hibernate', 5 | 'net.sf.ehcache.hibernate' 6 | } 7 | -------------------------------------------------------------------------------- /grails-app/conf/DataSource.groovy: -------------------------------------------------------------------------------- 1 | dataSource { 2 | pooled = true 3 | driverClassName = 'org.h2.Driver' 4 | username = 'sa' 5 | password = '' 6 | dbCreate = 'update' 7 | url = 'jdbc:h2:mem:testDb' 8 | } 9 | 10 | hibernate { 11 | cache.use_second_level_cache = false 12 | cache.use_query_cache = false 13 | cache.provider_class = 'org.hibernate.cache.EhCacheProvider' 14 | } 15 | -------------------------------------------------------------------------------- /grails-app/controllers/grails/plugin/executor/TestController.groovy: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2011 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package grails.plugin.executor 18 | 19 | class TestController { 20 | 21 | } -------------------------------------------------------------------------------- /grails-app/domain/executor/test/Book.groovy: -------------------------------------------------------------------------------- 1 | package executor.test 2 | import java.util.concurrent.atomic.AtomicBoolean 3 | 4 | class Book { 5 | static AtomicBoolean runAsyncFired = new AtomicBoolean(false) 6 | 7 | String name 8 | static constraints = { 9 | } 10 | 11 | def afterInsert(){ 12 | runAsync { 13 | runAsyncFired.set(true) 14 | } 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /grails-app/services/grails/plugin/executor/TestService.groovy: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2011 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package grails.plugin.executor 18 | 19 | class TestService { 20 | 21 | } -------------------------------------------------------------------------------- /src/groovy/grails/plugin/executor/PersistenceContextCallableWrapper.groovy: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2011 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package grails.plugin.executor 18 | 19 | import java.util.concurrent.Callable 20 | 21 | import org.codehaus.groovy.grails.support.PersistenceContextInterceptor 22 | 23 | /** 24 | * Wraps the execution of a Callable in a persistence context, via the persistenceInterceptor. 25 | */ 26 | class PersistenceContextCallableWrapper extends PersistenceContextWrapper implements Callable { 27 | 28 | private final Callable callable 29 | 30 | PersistenceContextCallableWrapper(PersistenceContextInterceptor persistenceInterceptor, Callable callable) { 31 | super(persistenceInterceptor) 32 | this.callable = callable 33 | } 34 | 35 | T call() { 36 | wrap { callable.call() } 37 | } 38 | } -------------------------------------------------------------------------------- /src/groovy/grails/plugin/executor/PersistenceContextExecutorWrapper.groovy: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2011 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package grails.plugin.executor 18 | 19 | import java.util.concurrent.Callable 20 | import java.util.concurrent.ExecutorService 21 | import java.util.concurrent.Future 22 | import java.util.concurrent.TimeUnit 23 | 24 | import org.codehaus.groovy.grails.support.PersistenceContextInterceptor 25 | import org.springframework.util.Assert 26 | 27 | /** 28 | * Wraps an ExecutorService, overriding the submitting methods to have the work done in a 29 | * persistence context (via the persistenceInterceptor) and adds new methods that make it possible 30 | * to still do work without opening a persistence context 31 | */ 32 | class PersistenceContextExecutorWrapper { 33 | 34 | // Autowired 35 | @Delegate ExecutorService executor 36 | PersistenceContextInterceptor persistenceInterceptor 37 | 38 | void execute(Runnable command) { 39 | executor.execute(inPersistence(command)) 40 | } 41 | 42 | void executeWithoutSession(Runnable command) { 43 | executor.execute(command) 44 | } 45 | 46 | void executeWithoutPersistence(Runnable command) { 47 | executor.execute(command) 48 | } 49 | 50 | public Future submit(Callable task) { 51 | executor.submit(inPersistence(task) as Callable) 52 | } 53 | 54 | public Future submitWithoutSession(Callable task) { 55 | executor.submit(task) 56 | } 57 | 58 | public Future submitWithoutPersistence(Callable task) { 59 | executor.submit(task) 60 | } 61 | 62 | Future submit(Runnable task) { 63 | executor.submit(inPersistence(task)) 64 | } 65 | 66 | Future submitWithoutSession(Runnable task) { 67 | executor.submit(task) 68 | } 69 | 70 | Future submitWithoutPersistence(Runnable task) { 71 | executor.submit(task) 72 | } 73 | 74 | public Future submit(Runnable task, T result) { 75 | executor.submit(inPersistence(task), result) 76 | } 77 | 78 | public Future submitWithoutSession(Runnable task, T result) { 79 | executor.submit(task, result) 80 | } 81 | 82 | public Future submitWithoutPersistence(Runnable task, T result) { 83 | executor.submit(task, result) 84 | } 85 | 86 | Future withSession(Closure task) { 87 | withPersistence(task) 88 | } 89 | 90 | Future withPersistence(Closure task) { 91 | executor.submit(inPersistence((Closure)task)) 92 | } 93 | 94 | Future withoutSession(Closure task) { 95 | executor.withoutPersistence(task) 96 | } 97 | 98 | Future withoutPersistence(Closure task) { 99 | executor.submit(task as Callable) 100 | } 101 | 102 | Future leftShift(Closure task) { 103 | withPersistence(task) 104 | } 105 | 106 | Callable inPersistence(Closure task) { 107 | inPersistence(task as Callable) 108 | } 109 | 110 | Callable inPersistence(Callable task) { 111 | Assert.state(persistenceInterceptor != null, 112 | "Unable to create persistence context wrapped callable because persistenceInterceptor is null") 113 | 114 | new PersistenceContextCallableWrapper(persistenceInterceptor, task) 115 | } 116 | 117 | Runnable inPersistence(Runnable task) { 118 | Assert.state(persistenceInterceptor != null, 119 | "Unable to create persistence context wrapped runnable because persistenceInterceptor is null") 120 | 121 | new PersistenceContextRunnableWrapper(persistenceInterceptor, task) 122 | } 123 | 124 | void destroy() { 125 | executor.shutdown() 126 | if (!executor.awaitTermination(5, TimeUnit.SECONDS)) { 127 | log.warn "ExecutorService did not shutdown in 5 seconds. Forcing shutdown of any scheduled tasks" 128 | executor.shutdownNow() 129 | } 130 | } 131 | } 132 | -------------------------------------------------------------------------------- /src/groovy/grails/plugin/executor/PersistenceContextRunnableWrapper.groovy: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2011 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package grails.plugin.executor 18 | 19 | import org.codehaus.groovy.grails.support.PersistenceContextInterceptor 20 | 21 | /** 22 | * Wraps the execution of a Runnable in a persistence context, via the persistenceInterceptor. 23 | */ 24 | class PersistenceContextRunnableWrapper extends PersistenceContextWrapper implements Runnable { 25 | 26 | private final Runnable runnable 27 | 28 | PersistenceContextRunnableWrapper(PersistenceContextInterceptor persistenceInterceptor, Runnable runnable) { 29 | super(persistenceInterceptor) 30 | this.runnable = runnable 31 | } 32 | 33 | void run() { 34 | wrap { runnable.run() } 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /src/groovy/grails/plugin/executor/PersistenceContextWrapper.groovy: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2011 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package grails.plugin.executor 18 | 19 | import org.codehaus.groovy.grails.support.PersistenceContextInterceptor 20 | 21 | /** 22 | * Wraps the execution of a Runnable in a persistence context, via the persistenceInterceptor. 23 | */ 24 | class PersistenceContextWrapper { 25 | 26 | private final PersistenceContextInterceptor persistenceInterceptor 27 | 28 | PersistenceContextWrapper(PersistenceContextInterceptor persistenceInterceptor) { 29 | this.persistenceInterceptor = persistenceInterceptor 30 | } 31 | 32 | protected wrap(Closure wrapped) { 33 | persistenceInterceptor.init() 34 | try { 35 | wrapped() 36 | } finally { 37 | try { 38 | persistenceInterceptor.flush() 39 | } finally { 40 | persistenceInterceptor.destroy() 41 | } 42 | } 43 | } 44 | } -------------------------------------------------------------------------------- /test/integration/grails/plugin/executor/AlternativeSyntaxesSpec.groovy: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2011 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package grails.plugin.executor 18 | 19 | import grails.plugin.spock.IntegrationSpec 20 | 21 | import java.util.concurrent.Future 22 | import java.util.concurrent.TimeUnit 23 | 24 | class AlternativeSyntaxesSpec extends IntegrationSpec { 25 | 26 | // Autowired 27 | def executorService 28 | 29 | def "left shift closure"() { 30 | when: 31 | def future = executorService << { 2 } 32 | 33 | then: 34 | future instanceof Future 35 | future.get(1, TimeUnit.SECONDS) 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /test/integration/grails/plugin/executor/DynamicMethodsSpec.groovy: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2011 the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package grails.plugin.executor 18 | 19 | import org.codehaus.groovy.grails.plugins.PluginManagerHolder 20 | 21 | import spock.lang.Unroll 22 | import executor.test.Book 23 | import grails.plugin.spock.IntegrationSpec 24 | 25 | class DynamicMethodsSpec extends IntegrationSpec { 26 | 27 | // Autowired 28 | def grailsApplication 29 | 30 | def currentClazz 31 | 32 | @Unroll("Reloading support for #clazz") 33 | def reloading() { 34 | setup: 35 | currentClazz = clazz 36 | 37 | expect: 38 | artifactHasExecutorMethods 39 | 40 | when: 41 | reloadClass() 42 | 43 | then: 44 | !artifactHasExecutorMethods 45 | 46 | when: 47 | informOfClassChange() 48 | 49 | then: 50 | artifactHasExecutorMethods 51 | 52 | where: 53 | clazz << [TestService, TestController] 54 | } 55 | 56 | def "domain classes"() { 57 | setup: 58 | currentClazz = Book 59 | 60 | expect: 61 | artifactHasExecutorMethods 62 | } 63 | 64 | protected getArtifactHasExecutorMethods() { 65 | createArtifact().respondsTo("runAsync", Runnable).size() > 0 66 | } 67 | 68 | protected createArtifact() { 69 | loadClass().newInstance() 70 | } 71 | 72 | protected loadClass() { 73 | grailsApplication.classLoader.loadClass(currentClazz.name) 74 | } 75 | 76 | protected reloadClass() { 77 | currentClazz = grailsApplication.classLoader.reloadClass(currentClazz.name) 78 | } 79 | 80 | protected informOfClassChange() { 81 | PluginManagerHolder.pluginManager.informOfClassChange(currentClazz) 82 | } 83 | } 84 | -------------------------------------------------------------------------------- /test/integration/grails/plugin/executor/PersistenceExecutorServiceTests.groovy: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2010 Robert Fletcher 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | package grails.plugin.executor 17 | 18 | import static org.junit.Assert.* 19 | 20 | import java.util.concurrent.Callable 21 | import java.util.concurrent.CountDownLatch 22 | import java.util.concurrent.Future 23 | import java.util.concurrent.TimeUnit 24 | 25 | import org.junit.After 26 | import org.junit.AfterClass 27 | import org.junit.Before 28 | import org.junit.Test 29 | 30 | import executor.test.Book 31 | 32 | class PersistenceExecutorServiceTests { 33 | 34 | static transactional = false 35 | 36 | def sessionFactory 37 | def executorService 38 | 39 | @Before 40 | void setup() { 41 | 42 | Book.withNewSession { 43 | 1.upto(5) { new Book(name: "$it").save() } 44 | } 45 | } 46 | 47 | @After 48 | void teardown() { 49 | Book.withNewSession { 50 | Book.list()*.delete() 51 | } 52 | } 53 | 54 | @Test 55 | void testExecute() { 56 | assertTrue Book.runAsyncFired.get() 57 | assert 5 == Book.count() 58 | 59 | def latch = new CountDownLatch(1) 60 | executorService.execute { 61 | assertEquals(5, Book.count()) 62 | Book.list()*.delete() 63 | new Book(name: "async book").save() 64 | latch.countDown() 65 | } 66 | 67 | waitFor "end of book delete task", latch 68 | //sleep for a second to wait for the thread to finish and the session to flush 69 | sleep(1000) 70 | assertEquals(1, Book.count()) 71 | } 72 | 73 | @Test 74 | void testSubmitCallable() { 75 | 76 | assert 5 == Book.count() 77 | 78 | def latch = new CountDownLatch(1) 79 | 80 | def closure = { 81 | assertEquals(5, Book.count()) 82 | sleep(2000) //give it a couple of seconds in here so we can test stuff 83 | Book.list()*.delete() 84 | def book = new Book(name: "async book").save() 85 | latch.countDown() 86 | return book 87 | } 88 | 89 | Future future = executorService.submit(closure as Callable) 90 | 91 | //this should fire while the submited callable task is still running still show 5 92 | assertEquals(5, Book.count()) 93 | 94 | waitFor "end of callable", latch, 4l 95 | //just to make sure we are good this thread before the other finishes 96 | new Book(name: "normal book").save() 97 | 98 | def fbook = future.get() //this will sit here and wait for the submited callable to finish and return the value. 99 | assertEquals "async book", fbook.name 100 | assertEquals(2, Book.count()) 101 | } 102 | 103 | @Test 104 | void testSubmitRunnable() { 105 | 106 | def latch = new CountDownLatch(1) 107 | 108 | Future future = executorService.submit( { 109 | //Book.withTransaction { 110 | Book.list()*.delete() 111 | //} 112 | latch.countDown() 113 | } as Runnable) 114 | 115 | waitFor "end of runnable", latch 116 | 117 | def fbook = future.get() //this will return a null since we sumbmited a runnable 118 | assertNull fbook 119 | assertEquals(0, Book.count()) 120 | } 121 | 122 | @Test 123 | void testSubmitRunnableWithReturn() { 124 | 125 | def latch = new CountDownLatch(1) 126 | def clos = { 127 | Book.list()*.delete() 128 | latch.countDown() 129 | } 130 | 131 | Future future = executorService.submit(clos,"nailed it" ) 132 | waitFor "end of runnable", latch 133 | 134 | def fbook = future.get() //this will return a null since we sumbmited a runnable 135 | assertEquals "nailed it", fbook 136 | assertEquals(0, Book.count()) 137 | 138 | } 139 | 140 | @AfterClass 141 | static void tearDownData() { 142 | /* Album.withNewSession { session -> 143 | Album.list()*.delete() 144 | session.flush() 145 | }*/ 146 | } 147 | 148 | static void waitFor(String message, CountDownLatch latch, long timeout = 1l) { 149 | if (!latch.await(timeout, TimeUnit.SECONDS)) { 150 | fail "Timed out waiting for $message, $latch.count more latch countDown should have run" 151 | } 152 | } 153 | } 154 | --------------------------------------------------------------------------------