#115 - performance improvements and bugfixes from feedback

Author: eouthwaite

deploy/ml-config.xml

@@ -253,6 +253,26 @@
 -->
       </range-element-indexes>
       <range-element-attribute-indexes>
+        <range-element-attribute-index>
+          <scalar-type>string</scalar-type>
+          <parent-namespace-uri>http://marklogic.com/workflow</parent-namespace-uri>
+          <parent-localname>process</parent-localname>
+          <namespace-uri/>
+          <localname>id</localname>
+          <collation>http://marklogic.com/collation/</collation>
+          <range-value-positions>false</range-value-positions>
+          <invalid-values>ignore</invalid-values>
+        </range-element-attribute-index>
+        <range-element-attribute-index>
+          <scalar-type>string</scalar-type>
+          <parent-namespace-uri>http://marklogic.com/workflow</parent-namespace-uri>
+          <parent-localname>attachment</parent-localname>
+          <namespace-uri/>
+          <localname>uri</localname>
+          <collation>http://marklogic.com/collation/</collation>
+          <range-value-positions>false</range-value-positions>
+          <invalid-values>ignore</invalid-values>
+        </range-element-attribute-index>
 <!--
         Sample for:
           <person name="bob" xmlns="http://marklogic.com/ns/sample"/>

documentation/INSTALL.md

@@ -1,4 +1,4 @@
-## Roxy Installation
+### Roxy Installation
 
 To install via roxy, within the roxy directory, edit the properties file for the target environment - for example, ``deploy/local.properties`` and run the following commands:
 

src/test/suites/e2e-rest-process-xml/015-processmodel-xml.xqy

@@ -17,6 +17,12 @@ return ( (:
   test:assert-equal('SUCCESS', xs:string($process[2]/createResponse/outcome)),
   test:assert-equal('015-restapi-tests__1__0', xs:string($process[2]/createResponse/modelId))
 );
+(:
+  <ext:createResponse xmlns:ext="http://marklogic.com/rest-api/resource/processmodel">
+    <ext:outcome>SUCCESS</ext:outcome>
+    <ext:modelId>015-restapi-tests__1__0</ext:modelId>
+  </ext:createResponse>
+:)
 
 (: 02-processmodel-read :)
 import module namespace const="http://marklogic.com/roxy/workflow-constants" at "/test/workflow-constants.xqy";
@@ -48,6 +54,12 @@ return ( (:
   test:assert-equal('SUCCESS', xs:string($result[2]/createResponse/outcome)),
   test:assert-equal('015-restapi-tests__1__2', xs:string($result[2]/createResponse/modelId))
 );
+(:
+  <ext:createResponse xmlns:ext="http://marklogic.com/rest-api/resource/processmodel">
+    <ext:outcome>SUCCESS</ext:outcome>
+    <ext:modelId>015-restapi-tests__1__2</ext:modelId>
+  </ext:createResponse>
+:)
 
 (: 04-processmodel-publish :)
 import module namespace const="http://marklogic.com/roxy/workflow-constants" at "/test/workflow-constants.xqy";
@@ -66,6 +78,12 @@ return ( (:
   test:assert-equal('SUCCESS', xs:string($result[2]/updateResponse/outcome)),
   test:assert-exists(xs:string($result[2]/updateResponse/domainId))
 );
+(:
+  <ext:updateResponse xmlns:ext="http://marklogic.com/rest-api/resource/processmodel">
+    <ext:outcome>SUCCESS</ext:outcome>
+    <ext:domainId>16663957717060497977</ext:domainId>
+  </ext:updateResponse>
+:)
 
 (: there is and has never been 05 :)
 
@@ -100,13 +118,21 @@ return (
   test:assert-equal('SUCCESS', xs:string($result[2]/ext:readResponse/ext:outcome)),
   test:assert-exists($result[2]/ext:readResponse/ext:document)
 );
+(:
+  <ext:readResponse xmlns:ext="http://marklogic.com/rest-api/resource/process">
+    <ext:outcome>SUCCESS</ext:outcome>
+    <ext:document/>
+  </ext:readResponse>
+:)
 
 (: 08-processinbox-read :)
 import module namespace const="http://marklogic.com/roxy/workflow-constants" at "/test/workflow-constants.xqy";
 import module namespace wrt="http://marklogic.com/workflow/rest-tests" at "/test/workflow-rest-tests.xqy";
 import module namespace test="http://marklogic.com/roxy/test-helper" at "/test/test-helper.xqy";
+declare namespace cpf = "http://marklogic.com/cpf";
 declare namespace ext = "http://marklogic.com/rest-api/resource/processinbox";
 declare namespace http = "xdmp:http";
+declare namespace prop = "http://marklogic.com/xdmp/property";
 declare namespace wf="http://marklogic.com/workflow";
 
 let $_pause := xdmp:sleep(5000)
@@ -115,7 +141,23 @@ let $result := wrt:test-08-processinbox-read($const:xml-options)
 return (
   test:assert-equal('200', xs:string($result[1]/http:code)),
   test:assert-equal('SUCCESS', xs:string($result[2]/ext:readResponse/ext:outcome)),
-  test:assert-exists($result[2]/ext:readResponse/wf:inbox/wf:task[@processid=$pid])
+  test:assert-exists($result[2]/ext:readResponse/wf:inbox/wf:task[@processid=$pid]),
+  let $task := $result[2]/ext:readResponse/wf:inbox/wf:task[@processid=$pid]
+  return (
+    test:assert-exists($task/wf:process-data/wf:process/wf:data),
+    test:assert-exists($task/wf:process-data/wf:process/wf:attachments),
+    test:assert-exists($task/wf:process-data/wf:process/wf:audit-trail),
+    test:assert-exists($task/wf:process-data/wf:process/wf:metrics),
+    test:assert-exists($task/wf:process-data/wf:process/wf:process-definition-name),
+    let $properties := $task/wf:process-properties/prop:properties
+    return (
+      test:assert-equal('done', xs:string($properties/cpf:processing-status)),
+      test:assert-equal('user', xs:string($properties/wf:currentStep/wf:type)),
+      test:assert-equal('admin', xs:string($properties/wf:currentStep/wf:assignee)),
+      test:assert-equal('userTask', xs:string($properties/wf:currentStep/wf:step-type)),
+      test:assert-equal('ENTERED', xs:string($properties/wf:currentStep/wf:step-status))
+    )
+  )
 );
 
 (: 09-process-update :)

src/workflowengine/actions/sendTask.xqy

@@ -55,7 +55,7 @@ try {
   (: If still none, throw failure message (misconfiguration) :)
   return
     (
-      xdmp:email($messageXml)
+      if(fn:empty($messageXml)) then () else xdmp:email($messageXml)
       ,
       wfu:complete( $cpf:document-uri, $cpf:transition, (), $st )
     )

src/workflowengine/models/alert-action-process.xqy

@@ -9,7 +9,6 @@ xquery version "1.0-ml";
 
 import module namespace alert = "http://marklogic.com/xdmp/alert" at "/MarkLogic/alert.xqy";
 declare namespace wf = "http://marklogic.com/workflow";
-import module namespace sem = "http://marklogic.com/semantics" at "/MarkLogic/semantics.xqy";
 
 import module namespace wfu="http://marklogic.com/workflow-util" at "/workflowengine/models/workflow-util.xqy";
 
@@ -29,12 +28,12 @@ let $pid :=   wfu:create($procname,$alert:doc/element(),
 return ()
 
 
-(:)
+(:
   xdmp:document-insert($procname || "/" || sem:uuid-string() || ".xml",
    <process xmlns="http://marklogic.com/workflow/process">
     <data>
     {
-      (: TODO check config for mappings options - rather than map entire document in:)
+      ( : TODO check config for mappings options - rather than map entire document in : )
       $alert:doc/element()
     }
     </data>

src/workflowengine/models/lib-search-subscribe.xqy

@@ -104,7 +104,7 @@ declare function ss:unsubscribe-and-delete-search($searchname,$notificationurl)
 declare function ss:save-subscribe-search($searchdoc as cts:query,$searchname as xs:string,$notificationurl as xs:string,$alert-detail as xs:string?,$content-type as xs:string?) {
   (: use current user on app server :)
   ( xdmp:eval(
-      fn:concat('xquery version "1.0-ml"; declare namespace my="http://marklogic.com/alerts"; import module namespace ah = "http://marklogic.com/search/subscribe" at "/modules/lib-search-subscribe.xqy";',
+      fn:concat('xquery version "1.0-ml"; declare namespace my="http://marklogic.com/alerts"; import module namespace ah = "http://marklogic.com/search/subscribe" at "/workflowengine/modules/lib-search-subscribe.xqy";',
                 'declare variable $my:searchdoc as cts:query external;declare variable $my:searchname as xs:string external;',
                 'ah:do-save($my:searchdoc,$my:searchname)'),
       (xs:QName("my:searchdoc"),$searchdoc,xs:QName("my:searchname"),$searchname),
@@ -160,14 +160,14 @@ declare function ss:do-subscribe-check($notificationurl as xs:string,$searchname
 declare function ss:do-add-action-rule($alert-name as xs:string,$notificationurl as xs:string,$alert-module as xs:string?,$alert-detail as xs:string,$content-type as xs:string,$searchname as xs:string,$cpf-domain as xs:string,$dbname as xs:string,$searchdoc as cts:query?) as xs:boolean {
 
   let $e2 := xdmp:eval(
-    fn:concat('xquery version "1.0-ml"; declare namespace my="http://marklogic.com/alerts"; import module namespace ah = "http://marklogic.com/search/subscribe" at "/modules/lib-search-subscribe.xqy";',
+    fn:concat('xquery version "1.0-ml"; declare namespace my="http://marklogic.com/alerts"; import module namespace ah = "http://marklogic.com/search/subscribe" at "/workflowengine/modules/lib-search-subscribe.xqy";',
               'declare variable $my:alert-name as xs:string external;declare variable $my:alert-module as xs:string external;declare variable $my:dbname as xs:string external;',
               'ah:create-action($my:alert-name,$my:alert-module,$my:dbname,())'),
     (xs:QName("my:alert-name"),$alert-name,xs:QName("my:alert-module"),$alert-module,xs:QName("my:dbname"),$dbname),
     <options xmlns="xdmp:eval"><isolation>different-transaction</isolation></options>
   )
   let $e3 := xdmp:eval(
-    fn:concat('xquery version "1.0-ml"; declare namespace my="http://marklogic.com/alerts"; import module namespace ah = "http://marklogic.com/search/subscribe" at "/modules/lib-search-subscribe.xqy";',
+    fn:concat('xquery version "1.0-ml"; declare namespace my="http://marklogic.com/alerts"; import module namespace ah = "http://marklogic.com/search/subscribe" at "/workflowengine/modules/lib-search-subscribe.xqy";',
               'declare variable $my:alert-name as xs:string external;declare variable $my:alert-detail as xs:string external;declare variable $my:content-type as xs:string external;',
               'declare variable $my:notificationurl as xs:string external;declare variable $my:searchname as xs:string external;declare variable $my:searchdoc as cts:query external;',
               'ah:create-rule-notify($my:alert-name,$my:alert-detail,$my:content-type,$my:notificationurl,$my:searchname,$my:searchdoc)'),
@@ -180,15 +180,15 @@ declare function ss:do-add-action-rule($alert-name as xs:string,$notificationurl
 
 declare function ss:do-subscribe($notificationurl as xs:string,$alert-module as xs:string?,$alert-detail as xs:string,$content-type as xs:string,$searchname as xs:string,$cpf-domain as xs:string,$dbname as xs:string,$searchdoc as cts:query?) as xs:boolean {
   let $alert-name := xdmp:eval(
-    fn:concat('xquery version "1.0-ml"; declare namespace my="http://marklogic.com/alerts"; import module namespace ah = "http://marklogic.com/search/subscribe" at "/modules/lib-search-subscribe.xqy";',
+    fn:concat('xquery version "1.0-ml"; declare namespace my="http://marklogic.com/alerts"; import module namespace ah = "http://marklogic.com/search/subscribe" at "/workflowengine/modules/lib-search-subscribe.xqy";',
               'declare variable $my:notificationurl as xs:string external;declare variable $my:searchname as xs:string external;',
               'ah:create-config($my:notificationurl,$my:searchname)'),
     (xs:QName("my:notificationurl"),$notificationurl,xs:QName("my:searchname"),$searchname),
     <options xmlns="xdmp:eval"><isolation>different-transaction</isolation></options>
   )
   let $e2 := ss:do-add-action-rule($alert-name,$notificationurl ,$alert-module,$alert-detail,$content-type,$searchname,$cpf-domain,$dbname,$searchdoc)
   let $e4 := xdmp:eval(
-    fn:concat('xquery version "1.0-ml"; declare namespace my="http://marklogic.com/alerts"; import module namespace ah = "http://marklogic.com/search/subscribe" at "/modules/lib-search-subscribe.xqy";',
+    fn:concat('xquery version "1.0-ml"; declare namespace my="http://marklogic.com/alerts"; import module namespace ah = "http://marklogic.com/search/subscribe" at "/workflowengine/modules/lib-search-subscribe.xqy";',
               'declare variable $my:alert-name as xs:string external;declare variable $my:cpf-domain as xs:string external;',
               'ah:cpf-enable($my:alert-name,$my:cpf-domain)'),
     (xs:QName("my:alert-name"),$alert-name,xs:QName("my:cpf-domain"),$cpf-domain),
@@ -207,15 +207,15 @@ declare function ss:do-unsubscribe($notificationurl as xs:string,$searchname as
       alert:rule-remove($alert-name,$rule/@id)
 
   let $l := xdmp:eval(
-    fn:concat('xquery version "1.0-ml"; declare namespace my="http://marklogic.com/alerts"; import module namespace ah = "http://marklogic.com/search/subscribe" at "/modules/lib-search-subscribe.xqy";',
+    fn:concat('xquery version "1.0-ml"; declare namespace my="http://marklogic.com/alerts"; import module namespace ah = "http://marklogic.com/search/subscribe" at "/workflowengine/modules/lib-search-subscribe.xqy";',
               'import module namespace alert="http://marklogic.com/xdmp/alert" at "/MarkLogic/alert.xqy";',
               'declare variable $my:alert-name as xs:string external;',
               'alert:config-set-cpf-domain-names(alert:config-get($my:alert-name), ())'),
     (xs:QName("my:alert-name"),$alert-name),
     <options xmlns="xdmp:eval"><isolation>different-transaction</isolation></options>
   )(:)
   let $e1 := xdmp:eval(
-    fn:concat('xquery version "1.0-ml"; declare namespace my="http://marklogic.com/alerts"; import module namespace ah = "http://marklogic.com/search/subscribe" at "/modules/lib-search-subscribe.xqy";',
+    fn:concat('xquery version "1.0-ml"; declare namespace my="http://marklogic.com/alerts"; import module namespace ah = "http://marklogic.com/search/subscribe" at "/workflowengine/modules/lib-search-subscribe.xqy";',
               'import module namespace alert="http://marklogic.com/xdmp/alert" at "/MarkLogic/alert.xqy";',
               'declare variable $my:alert-name as xs:string external;',
               'alert:config-delete($my:alert-name)'),

src/workflowengine/models/workflow-actions.xqy

@@ -19,16 +19,16 @@ declare namespace error="http://marklogic.com/xdmp/error";
 (: EXTERNAL CALLABLE FUNCTIONS - update-* updates the task, but does not complete it. complete-* does update and complete. :)
 
 declare function update-userTask($processId as xs:string,$data as node()*,$attachments as node()*) as node()? {
-  let $_ := xdmp:log("In wfa:update-userTask")
+  let $_ := xdmp:log("In wfa:update-userTask processId: "|| $processId, "debug")
   return
-    update-generic($processId,$data,$attachments)
+    update-generic($processId, $data, $attachments)
 };
 
 (:
  : Complete a user task, moving it on to the next step. (Just marks as complete)
  :)
 declare function complete-userTask($processId as xs:string,$data as node()*,$attachments as node()*) as node()? {
-  let $_ := xdmp:log("In wfa:complete-userTask")
+  let $_ := xdmp:log("In wfa:complete-userTask processId: "|| $processId, "debug")
   let $unlock :=
     if (fn:not(fn:empty(wfu:getProperties($processId)/wf:currentStep/wf:lock))) then
       wfu:unlock($processId) (: We call this to ensure this user has the current lock, even though wf:currentStep will be deleted :)
@@ -51,27 +51,27 @@ declare function complete-userTask($processId as xs:string,$data as node()*,$att
 
 (: INTERNAL METHODS :)
 declare function update-generic($processId as xs:string,$data as node()*,$attachments as node()*) as node()? {
-  let $_ := xdmp:log("In wfa:update-generic")
-
-	let $previous-data := fn:doc(wfu:getProcessUri($processId))/wf:process/wf:data
-	let $previous-attach := fn:doc(wfu:getProcessUri($processId))/wf:process/wf:attachments
+  let $_ := xdmp:log("In wfa:update-generic processId: "|| $processId, "debug")
+  let $doc := fn:doc(wfu:getProcessUri($processId))
+  let $previous-data := $doc/wf:process/wf:data
+  let $previous-attach := $doc/wf:process/wf:attachments
 
   return (
-      xdmp:node-replace(fn:doc(wfu:getProcessUri($processId))/wf:process/wf:data,
+      xdmp:node-replace($doc/wf:process/wf:data,
         (: Keep previous data if not newly sent and add new elements :)
         element wf:data {
           ($previous-data/* except $data/(let $qname := fn:node-name(.) return $previous-data/*[fn:node-name(.) eq $qname])),
           $data
         }
       ),
-      xdmp:node-replace(fn:doc(wfu:getProcessUri($processId))/wf:process/wf:attachments,
-      	(: Keep previous data if not newly sent and add new elements :)
+      xdmp:node-replace($doc/wf:process/wf:attachments,
+        (: Keep previous data if not newly sent and add new elements :)
         element wf:attachments {
           ($previous-attach/* except $previous-attach/*[@name eq $attachments/@name]),
           $attachments
         }
       )
-  )
+    )
 };
 
 (:

src/workflowengine/models/workflow-import.xqy

@@ -1,21 +1,16 @@
 xquery version "1.0-ml";
 
 module namespace m="http://marklogic.com/workflow-import";
-declare namespace wf="http://marklogic.com/workflow";
-
-declare namespace sc="http://www.w3.org/2005/07/scxml";
-declare namespace b2="http://www.omg.org/spec/BPMN/20100524/MODEL";
-
 
 import module namespace p="http://marklogic.com/cpf/pipelines" at "/MarkLogic/cpf/pipelines.xqy";
 import module namespace dom = "http://marklogic.com/cpf/domains" at "/MarkLogic/cpf/domains.xqy";
-
-
 import module namespace stack="http://marklogic.com/stack" at "/workflowengine/models/lib-stack.xqy";
-
-
 import module namespace ss = "http://marklogic.com/alerts/alerts" at "/workflowengine/models/lib-alerts.xqy";
 
+declare namespace wf="http://marklogic.com/workflow";
+declare namespace sc="http://www.w3.org/2005/07/scxml";
+declare namespace b2="http://www.omg.org/spec/BPMN/20100524/MODEL";
+
 (: TODO replace following outgoing routes with call to m:b2getNextSteps() :)
 
 (: REST API OR XQUERY PUBLIC API FUNCTIONS :)