CROSSLINK-264 retry-action

broker/patron_request/service/action_mapping_test.go

@@ -22,11 +22,12 @@ func TestNewReturnableActionMapping(t *testing.T) {
 		BorrowerStateReceived:         {{actionName: BorrowerActionCheckOut}},
 		BorrowerStateCheckedOut:       {{actionName: BorrowerActionCheckIn}},
 		BorrowerStateCheckedIn:        {{actionName: BorrowerActionShipReturn}},
+		BorrowerStateRetryPending:     {{actionName: BorrowerActionAcceptRetry}, {actionName: BorrowerActionRejectRetry}},
 	}
 
 	lenderStateActionMapping := map[pr_db.PatronRequestState][]PatronRequestAction{
 		LenderStateNew:               {{actionName: LenderActionValidate, auto: true}},
-		LenderStateValidated:         {{actionName: LenderActionWillSupply, auto: true}, {actionName: LenderActionCannotSupply}, {actionName: LenderActionAddCondition}},
+		LenderStateValidated:         {{actionName: LenderActionWillSupply, auto: true}, {actionName: LenderActionCannotSupply}, {actionName: LenderActionAddCondition}, {actionName: LenderActionAskRetry}},
 		LenderStateWillSupply:        {{actionName: LenderActionAddCondition}, {actionName: LenderActionShip}, {actionName: LenderActionCannotSupply}},
 		LenderStateConditionPending:  {{actionName: LenderActionAddCondition}, {actionName: LenderActionCannotSupply}},
 		LenderStateConditionAccepted: {{actionName: LenderActionAddCondition}, {actionName: LenderActionShip}, {actionName: LenderActionCannotSupply}},
@@ -165,7 +166,7 @@ func mapCompare(t *testing.T, map1 map[pr_db.PatronRequestState][]PatronRequestA
 	for stateName := range map1 {
 		listOne := map1[stateName]
 		listTwo := map2[stateName]
-		assert.Equal(t, len(listOne), len(listTwo))
+		assert.Equal(t, len(listOne), len(listTwo), "State %s has different number of actions in the two maps", stateName)
 		for i := range listOne {
 			assert.Equal(t, listOne[i].actionName, listTwo[i].actionName)
 			assert.Equal(t, listOne[i].auto, listTwo[i].auto)

broker/patron_request/service/statemodel_capabilities.go

@@ -36,6 +36,9 @@ const (
 	BorrowerStateCompleted        pr_db.PatronRequestState = "COMPLETED"
 	BorrowerStateCancelled        pr_db.PatronRequestState = "CANCELLED"
 	BorrowerStateUnfilled         pr_db.PatronRequestState = "UNFILLED"
+	BorrowerStateRetryPending     pr_db.PatronRequestState = "RETRY_PENDING"
+	BorrowerStateRetryAccepted    pr_db.PatronRequestState = "RETRY_ACCEPTED"
+	BorrowerStateRetryRejected    pr_db.PatronRequestState = "RETRY_REJECTED"
 	LenderStateNew                pr_db.PatronRequestState = "NEW"
 	LenderStateValidated          pr_db.PatronRequestState = "VALIDATED"
 	LenderStateWillSupply         pr_db.PatronRequestState = "WILL_SUPPLY"
@@ -48,6 +51,7 @@ const (
 	LenderStateCompleted          pr_db.PatronRequestState = "COMPLETED"
 	LenderStateCancelled          pr_db.PatronRequestState = "CANCELLED"
 	LenderStateUnfilled           pr_db.PatronRequestState = "UNFILLED"
+	LenderStateCompletedWithRetry pr_db.PatronRequestState = "COMPLETED_WITH_RETRY"
 )
 
 const (
@@ -60,6 +64,8 @@ const (
 	BorrowerActionCheckOut        pr_db.PatronRequestAction = "check-out"
 	BorrowerActionCheckIn         pr_db.PatronRequestAction = "check-in"
 	BorrowerActionShipReturn      pr_db.PatronRequestAction = "ship-return"
+	BorrowerActionAcceptRetry     pr_db.PatronRequestAction = "accept-retry"
+	BorrowerActionRejectRetry     pr_db.PatronRequestAction = "reject-retry"
 
 	LenderActionValidate     pr_db.PatronRequestAction = "validate"
 	LenderActionWillSupply   pr_db.PatronRequestAction = "will-supply"
@@ -69,22 +75,24 @@ const (
 	LenderActionShip         pr_db.PatronRequestAction = "ship"
 	LenderActionMarkReceived pr_db.PatronRequestAction = "mark-received"
 	LenderActionAcceptCancel pr_db.PatronRequestAction = "accept-cancel"
+	LenderActionAskRetry     pr_db.PatronRequestAction = "ask-retry"
 )
 
 const (
-	SupplierExpectToSupply MessageEvent = "expect-to-supply"
-	SupplierWillSupply     MessageEvent = "will-supply"
-	SupplierWillSupplyCond MessageEvent = "will-supply-conditional"
-	SupplierLoaned         MessageEvent = "loaned"
-	SupplierCompleted      MessageEvent = "completed"
-	SupplierUnfilled       MessageEvent = "unfilled"
-	SupplierCancelAccepted MessageEvent = "cancel-accepted"
-	SupplierCancelRejected MessageEvent = "cancel-rejected"
-	RequesterCancelRequest MessageEvent = "cancel-request"
-	RequesterReceived      MessageEvent = "received"
-	RequesterShippedReturn MessageEvent = "shipped-return"
-	RequesterCondAccepted  MessageEvent = "conditions-accepted"
-	RequesterCondRejected  MessageEvent = "condition-rejected"
+	SupplierExpectToSupply   MessageEvent = "expect-to-supply"
+	SupplierWillSupply       MessageEvent = "will-supply"
+	SupplierWillSupplyCond   MessageEvent = "will-supply-conditional"
+	SupplierLoaned           MessageEvent = "loaned"
+	SupplierCompleted        MessageEvent = "completed"
+	SupplierUnfilled         MessageEvent = "unfilled"
+	SupplierCancelAccepted   MessageEvent = "cancel-accepted"
+	SupplierCancelRejected   MessageEvent = "cancel-rejected"
+	RequesterCancelRequest   MessageEvent = "cancel-request"
+	RequesterReceived        MessageEvent = "received"
+	RequesterShippedReturn   MessageEvent = "shipped-return"
+	RequesterCondAccepted    MessageEvent = "conditions-accepted"
+	RequesterCondRejected    MessageEvent = "condition-rejected"
+	SupplierRetryConditional MessageEvent = "retry-conditional"
 )
 
 func requesterBuiltInStates() []string {
@@ -104,6 +112,9 @@ func requesterBuiltInStates() []string {
 		string(BorrowerStateCompleted),
 		string(BorrowerStateCancelled),
 		string(BorrowerStateUnfilled),
+		string(BorrowerStateRetryAccepted),
+		string(BorrowerStateRetryRejected),
+		string(BorrowerStateRetryPending),
 	})
 }
 
@@ -121,6 +132,7 @@ func supplierBuiltInStates() []string {
 		string(LenderStateCompleted),
 		string(LenderStateCancelled),
 		string(LenderStateUnfilled),
+		string(LenderStateCompletedWithRetry),
 	})
 }
 
@@ -162,6 +174,14 @@ func requesterBuiltInActions() []proapi.ActionCapability {
 			Name:       string(BorrowerActionShipReturn),
 			Parameters: []string{},
 		},
+		{
+			Name:       string(BorrowerActionAcceptRetry),
+			Parameters: []string{},
+		},
+		{
+			Name:       string(BorrowerActionRejectRetry),
+			Parameters: []string{},
+		},
 	}
 }
 
@@ -211,6 +231,10 @@ func supplierBuiltInActions() []proapi.ActionCapability {
 			Name:       string(LenderActionAcceptCancel),
 			Parameters: []string{},
 		},
+		{
+			Name:       string(LenderActionAskRetry),
+			Parameters: []string{},
+		},
 	}
 }
 
@@ -234,6 +258,7 @@ func supplierBuiltInMessageEvents() []string {
 		string(SupplierUnfilled),
 		string(SupplierCancelAccepted),
 		string(SupplierCancelRejected),
+		string(SupplierRetryConditional),
 	})
 }
 

broker/patron_request/service/statemodels/returnables.json

@@ -67,6 +67,11 @@
           "name": "unfilled",
           "desc": "Supplier cannot supply (ISO18626 Unfilled)",
           "transition": "UNFILLED"
+        },
+        {
+          "name": "retry-conditional",
+          "desc": "Received retry from supplier",
+          "transition": "RETRY_PENDING"
         }
       ]
     },
@@ -96,6 +101,11 @@
           "desc": "Supplier will supply with conditions (ISO18626 WillSupply with conditions)",
           "transition": "CONDITION_PENDING"
         },
+        {
+          "name": "retry-conditional",
+          "desc": "Received retry from supplier",
+          "transition": "RETRY_PENDING"
+        },
         {
           "name": "loaned",
           "desc": "Supplier shipped the item (ISO18626 Loaned)",
@@ -144,6 +154,30 @@
         }
       ]
     },
+    {
+      "name": "RETRY_PENDING",
+      "display": "Retry Pending",
+      "desc": "Received supplier retry request with new conditions after initial conditions were rejected",
+      "side": "REQUESTER",
+      "primaryAction": "accept-retry",
+      "needsAttention": true,
+      "actions": [
+        {
+          "name": "accept-retry",
+          "desc": "Requester accepts supplier retry request",
+          "transitions": {
+            "success": "RETRY_ACCEPTED"
+          }
+        },
+        {
+          "name": "reject-retry",
+          "desc": "Requester rejects supplier retry request",
+          "transitions": {
+            "success": "RETRY_REJECTED"
+          }
+        }
+      ]
+    },
     {
       "name": "WILL_SUPPLY",
       "display": "Will Supply",
@@ -293,6 +327,20 @@
       "side": "REQUESTER",
       "terminal": true
     },
+    {
+      "name": "RETRY_ACCEPTED",
+      "display": "Retry Accepted",
+      "desc": "Requester accepted supplier retry request with new metadata",
+      "side": "REQUESTER",
+      "terminal": true
+    },
+    {
+      "name": "RETRY_REJECTED",
+      "display": "Retry Rejected",
+      "desc": "Requester rejected supplier retry request",
+      "side": "REQUESTER",
+      "terminal": true
+    },
     {
       "name": "NEW",
       "display": "New",
@@ -338,6 +386,13 @@
           "transitions": {
             "success": "CONDITION_PENDING"
           }
+        },
+        {
+          "name": "ask-retry",
+          "desc": "Ask requester to retry with new ISO18626 metadata",
+          "transitions": {
+            "success": "COMPLETED_WITH_RETRY"
+          }
         }
       ],
       "events": [
@@ -547,6 +602,13 @@
       "desc": "After manual cannot-supply or automatically if auto-responder is on",
       "side": "SUPPLIER",
       "terminal": true
+    },
+    {
+      "name": "COMPLETED_WITH_RETRY",
+      "display": "Completed with Retry",
+      "desc": "After sending retry to requester",
+      "side": "SUPPLIER",
+      "terminal": true
     }
   ]
 }

misc/returnables.yaml

@@ -48,6 +48,9 @@ states:
       - name: unfilled
         desc: Supplier cannot supply (ISO18626 Unfilled)
         transition: UNFILLED
+      - name: retry-conditional
+        desc: Received retry from supplier
+        transition: RETRY_PENDING
 
   - name: SUPPLIER_LOCATED
     display: Supplier Located
@@ -66,6 +69,9 @@ states:
       - name: will-supply-conditional
         desc: Supplier will supply with conditions (ISO18626 WillSupply with conditions)
         transition: CONDITION_PENDING
+      - name: retry-conditional
+        desc: Received retry from supplier
+        transition: RETRY_PENDING
       - name: loaned
         desc: Supplier shipped the item (ISO18626 Loaned)
         transition: SHIPPED
@@ -96,6 +102,22 @@ states:
         desc: Supplier cannot supply (ISO18626 Unfilled)
         transition: UNFILLED
 
+  - name: RETRY_PENDING
+    display: Retry Pending
+    desc: Received supplier retry request with new conditions after initial conditions were rejected
+    side: REQUESTER
+    primaryAction: accept-retry
+    needsAttention: true
+    actions:
+      - name: accept-retry
+        desc: Requester accepts supplier retry request
+        transitions:
+          success: RETRY_ACCEPTED
+      - name: reject-retry
+        desc: Requester rejects supplier retry request
+        transitions:
+          success: RETRY_REJECTED
+
   - name: WILL_SUPPLY
     display: Will Supply
     desc: Received ISO18626 WillSupply (without condition)
@@ -200,6 +222,18 @@ states:
     side: REQUESTER
     terminal: true
 
+  - name: RETRY_ACCEPTED
+    display: Retry Accepted
+    desc: Requester accepted supplier retry request with new metadata
+    side: REQUESTER
+    terminal: true
+
+  - name: RETRY_REJECTED
+    display: Retry Rejected
+    desc: Requester rejected supplier retry request
+    side: REQUESTER
+    terminal: true
+
   # Supplier-side
   - name: NEW
     display: New
@@ -232,6 +266,10 @@ states:
         desc: Indicate will supply with conditions and send ISO18626 WillSupply
         transitions:
           success: CONDITION_PENDING
+      - name: ask-retry
+        desc: Ask requester to retry with new ISO18626 metadata
+        transitions:
+          success: COMPLETED_WITH_RETRY
     events:
       - name: cancel-request
         desc: Requester sent ISO18626 Cancel
@@ -369,3 +407,9 @@ states:
     desc: After manual cannot-supply or automatically if auto-responder is on
     side: SUPPLIER
     terminal: true
+
+  - name: COMPLETED_WITH_RETRY
+    display: Completed with Retry
+    desc: After sending retry to requester
+    side: SUPPLIER
+    terminal: true