Merge pull request #12 from binlecode/issue/011-log-changeSet-exception

Issue/011 log change set exception

Author: binlecode

README.md

@@ -101,6 +101,22 @@ class BootStrap {
 }
 ```
 
+## CHANGE LOG
+
+#### v 0.9.1
+- issue-11: change entry log can intercept and save exception during change set invocation, and then bubble back to main execution flow  
+
+#### v 0.9
+- issue-9: simplify hosting app to save the manual line adding in host app bootstrap.groovy
+
+#### v 0.8
+- issue-4: add run-count support in changeEntry persistence for those repeatable changeSets
+
+#### v 0.7 and under
+- issue-3: add loop/lock-retry ability to application start-up
+
+
+
 ## CONTRIBUTORS
 
 Bin Le ([email protected])

mongogee/build.gradle

@@ -8,7 +8,7 @@ buildscript {
     }
 }
 
-version "0.9"
+version "0.9.1"
 group "org.grails.plugins"
 
 apply plugin:"eclipse"

mongogee/grails-app/domain/grails/plugin/mongogee/ChangeEntryLog.groovy

@@ -19,8 +19,13 @@ class ChangeEntryLog {
     String author
     String host = 'localhost'
 
+    String status
+    String message
+
     static constraints = {
         author nullable: true
+        status nullable: true, inList: ['success', 'fail']
+        message nullable: true
     }
 
     static mapWith = 'mongo'

mongogee/grails-app/services/grails/plugin/mongogee/MongogeeService.groovy

@@ -135,45 +135,68 @@ class MongogeeService {
         }
     }
 
+    /**
+     * Apply change with given changeSet method and changeLog object.
+     *
+     * @param changeSetMethod  {@link java.lang.reflect.Method} instance whose definition is {@link ChangeSet} annotated
+     * @param changeLogInstance  changeLog instance whose definition is {@link ChangeLog} annotated
+     * @param changeAgent  {@link ChangeAgent} instance
+     */
     protected applyChangeSet(Method changeSetMethod, changeLogInstance, ChangeAgent changeAgent) {
         ChangeEntry changeEntry = buildChangeEntry(changeSetMethod)
         if (!changeEntry) {
-            return // return from current iteration
+            return
         }
 
         ChangeEntry existingChangeEntry = ChangeEntry.findByChangeSetId(changeEntry.changeSetId)
 
-        //todo: try-catch the invocation so the error/exp msg can be saved to changeEntryLog domain record
-
         if (!existingChangeEntry) {
             log.info "applying new changeSet: $changeEntry"
-            invokeChangeSetMethod(changeSetMethod, changeLogInstance)
-
-            ChangeEntry.withNewTransaction {
-                changeEntry.save(failOnError: true, flush: true)
-                buildChangeEntryLog(changeEntry).save(failOnError: true, flush: true)
-            }
-            log.info " ... changeSet applied"
+            invokeChangeSetWithEntry(changeSetMethod, changeEntry, changeLogInstance)
 
         } else if (changeAgent.isRunAlwaysChangeSet(changeSetMethod)) {
-            log.info "reapplying changeSet: $changeEntry"
-            invokeChangeSetMethod(changeSetMethod, changeLogInstance)
 
-            ChangeEntry.withNewTransaction {
-                if (changeEntry.author) {
-                    existingChangeEntry.author = changeEntry.author
-                }
-                existingChangeEntry.runCount += 1
-                existingChangeEntry.save(failOnError: true, flush: true)
-                buildChangeEntryLog(existingChangeEntry).save(failOnError: true, flush: true)
+            // merge changeEntry into existing changeEntry and update other attributes
+            if (changeEntry.author) {
+                existingChangeEntry.author = changeEntry.author
             }
-            log.info " ... changeSet reapplied"
+            existingChangeEntry.runCount += 1
+            changeEntry = existingChangeEntry
+
+            log.info "reapplying existing changeSet: $changeEntry"
+            invokeChangeSetWithEntry(changeSetMethod, changeEntry, changeLogInstance)
 
         } else {
             log.info "changeSet skipped: $changeEntry"
         }
     }
 
+    /**
+     * Invoke the chagneSet, save changeEntry info, and log success or failure, when there's exception, the exception
+     * is saved to change entry log, and then bubbled up to main execution flow.
+     */
+    protected invokeChangeSetWithEntry(Method changeSetMethod, ChangeEntry changeEntry, changeLogInstance) {
+        try {
+            invokeChangeSetMethod(changeSetMethod, changeLogInstance)
+            log.info "changeSet invoked"
+
+            ChangeEntry.withNewTransaction {
+                changeEntry.save(failOnError: true, flush: true)
+                def changeEntryLog = buildChangeEntryLog(changeEntry).save(failOnError: true)
+                log.debug "changeEntry saved [id: ${changeEntry.id}], and logged [id: ${changeEntryLog.id}]"
+            }
+        } catch (ex) {
+            log.error "changeSet invocation error: ${ex.message ?: ex.toString().take(255)}"
+            // save error information to change entry log
+            ChangeEntryLog.withNewTransaction {
+                def changeEntryLog = buildChangeEntryErrorLog(changeEntry, ex).save(failOnError: true)
+                log.debug "changeSet invocation error logged [id: ${changeEntryLog.id}]"
+            }
+            // bubble exp to main flow
+            throw ex
+        }
+    }
+
     /**
      * Invoke changeSet method based on method argument specification.
      */
@@ -202,6 +225,13 @@ class MongogeeService {
         }
     }
 
+    /**
+     * Builds a change entry object from the input annotated {@link ChangeSet} method.
+     * If the input method is not valid, return null.
+     *
+     * @param changeSetMethod   {@link ChangeSet} annotated {@link java.lang.reflect.Method} object
+     * @return {@link ChangeEntry} object, or null
+     */
     protected ChangeEntry buildChangeEntry(Method changeSetMethod) {
         if (changeSetMethod.isAnnotationPresent(ChangeSet.class)) {
             ChangeSet annotation = changeSetMethod.getAnnotation(ChangeSet.class)
@@ -227,4 +257,11 @@ class MongogeeService {
         return cel
     }
 
+    protected ChangeEntryLog buildChangeEntryErrorLog(ChangeEntry changeEntry, Exception exp) {
+        ChangeEntryLog cel = buildChangeEntryLog(changeEntry)
+        cel.status = 'fail'
+        cel.message = exp.message ?: exp.toString().take(255)
+        return cel
+    }
+
 }

test-g3-mongodb/grails-app/conf/application.yml

@@ -139,7 +139,7 @@ environments:
 mongogee:
     changeLogsScanPackage: 'test.g3.mongodb.datamigration'
     changeEnabled: true                 # default to true
-    continueWithError: false            # default to false
+    continueWithError: true             # default to false
 #    lockingRetryEnabled: false          # default to true
     lockingRetryIntervalMillis: 3000    # default to 5s
     lockingRetryMax: 3                  # default to 120, aka 10min

test-g3-mongodb/src/main/groovy/test/g3/mongodb/datamigration/Dm001.groovy

@@ -29,4 +29,9 @@ class Dm001 {
         Document.collection.insert(name: "document at ${new Date()}")
     }
 
+    @ChangeSet(order = '003', id = '001.003.loadDocumentDataWithException', author = 'test-mongogee-app', runAlways = true)
+    def loadDocumentDataWithException() {
+        throw new RuntimeException('Test exception thrown from changeSet: 001.003.loadDocumentDataWithException')
+    }
+
 }