CROSSLINK-264 retry-action

broker/patron_request/service/action.go

@@ -51,6 +51,8 @@ type actionParams struct {
 	Cost           *float64 `json:"cost,omitempty"`
 	Currency       string   `json:"currency,omitempty"`
 	ReasonUnfilled string   `json:"reasonUnfilled,omitempty"`
+	ReasonRetry    string   `json:"reasonRetry,omitempty"`
+	ItemId         string   `json:"itemId,omitempty"`
 }
 
 func CreatePatronRequestActionService(prRepo pr_db.PrRepo, eventBus events.EventBus, iso18626Handler handler.Iso18626HandlerInterface, lmsCreator lms.LmsCreator) *PatronRequestActionService {
@@ -275,6 +277,10 @@ func (a *PatronRequestActionService) handleBorrowingAction(ctx common.ExtendedCo
 		return a.acceptConditionBorrowingRequest(ctx, pr)
 	case BorrowerActionRejectCondition:
 		return a.rejectConditionBorrowingRequest(ctx, pr)
+	case BorrowerActionRejectRetry:
+		return a.rejectRetryBorrowingRequest(pr)
+	case BorrowerActionAcceptRetry:
+		return a.acceptRetryBorrowingRequest(pr)
 	default:
 		status, result := logActionErrorAndReturnResult(ctx, "borrower action "+string(action)+" is not implemented yet", errors.New("invalid action"))
 		return actionExecutionResult{status: status, result: result, pr: pr}
@@ -329,6 +335,8 @@ func (a *PatronRequestActionService) handleLenderAction(ctx common.ExtendedConte
 		return a.markReceivedLenderRequest(ctx, pr, lms)
 	case LenderActionAcceptCancel:
 		return a.acceptCancelLenderRequest(ctx, pr)
+	case LenderActionAskRetry:
+		return a.askRetryLenderRequest(ctx, pr, params)
 	default:
 		status, result := logActionErrorAndReturnResult(ctx, "lender action "+string(action)+" is not implemented yet", errors.New("invalid action"))
 		return actionExecutionResult{status: status, result: result, pr: pr}
@@ -528,6 +536,17 @@ func (a *PatronRequestActionService) rejectConditionBorrowingRequest(ctx common.
 	return actionExecutionResult{status: events.EventStatusSuccess, result: &result, pr: pr}
 }
 
+func (a *PatronRequestActionService) rejectRetryBorrowingRequest(pr pr_db.PatronRequest) actionExecutionResult {
+	result := events.EventResult{}
+	return actionExecutionResult{status: events.EventStatusSuccess, result: &result, pr: pr}
+}
+
+func (a *PatronRequestActionService) acceptRetryBorrowingRequest(pr pr_db.PatronRequest) actionExecutionResult {
+	// TODO: link request IDs
+	result := events.EventResult{}
+	return actionExecutionResult{status: events.EventStatusSuccess, result: &result, pr: pr}
+}
+
 func (a *PatronRequestActionService) validateLenderRequest(ctx common.ExtendedContext, pr pr_db.PatronRequest, lms lms.LmsAdapter) actionExecutionResult {
 	institutionalPatron := lms.InstitutionalPatron(pr.RequesterSymbol.String)
 	_, err := lms.LookupUser(institutionalPatron)
@@ -772,6 +791,32 @@ func (a *PatronRequestActionService) acceptCancelLenderRequest(ctx common.Extend
 	return a.checkSupplyingResponse(status, eventResult, &result, httpStatus, pr)
 }
 
+func (a *PatronRequestActionService) askRetryLenderRequest(ctx common.ExtendedContext, pr pr_db.PatronRequest, params actionParams) actionExecutionResult {
+	var deliveryInfo *iso18626.DeliveryInfo
+	if params.ItemId != "" {
+		deliveryInfo = &iso18626.DeliveryInfo{
+			ItemId: params.ItemId,
+		}
+	}
+	reasonRetry := string(iso18626.ReasonRetryNotFoundAsCited)
+	if params.ReasonRetry != "" {
+		reasonRetry = params.ReasonRetry
+	}
+	result := events.EventResult{}
+	status, eventResult, httpStatus := a.sendSupplyingAgencyMessage(ctx, pr, &result,
+		iso18626.MessageInfo{
+			ReasonRetry:      &iso18626.TypeSchemeValuePair{Text: reasonRetry},
+			ReasonForMessage: iso18626.TypeReasonForMessageStatusChange,
+			Note:             params.Note,
+		},
+		iso18626.StatusInfo{Status: iso18626.TypeStatusRetryPossible},
+		deliveryInfo)
+	if result.OutgoingMessage.SupplyingAgencyMessage != nil {
+		setSupplierMessage(*result.OutgoingMessage.SupplyingAgencyMessage, &pr)
+	}
+	return a.checkSupplyingResponse(status, eventResult, &result, httpStatus, pr)
+}
+
 func (a *PatronRequestActionService) checkSupplyingResponse(status events.EventStatus, eventResult *events.EventResult, result *events.EventResult, httpStatus *int, pr pr_db.PatronRequest) actionExecutionResult {
 	if httpStatus == nil {
 		return actionExecutionResult{status: status, result: eventResult, pr: pr}

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/action_test.go

@@ -1097,6 +1097,66 @@ func TestHandleInvokeLenderActionAddConditionOK(t *testing.T) {
 	}
 }
 
+func TestHandleInvokeLenderActionAskRetryMinimal(t *testing.T) {
+	mockPrRepo := new(MockPrRepo)
+	lmsCreator := new(MockLmsCreator)
+	lmsCreator.On("GetAdapter", "ISIL:SUP1").Return(lms.CreateLmsAdapterMockOK(), nil)
+	mockIso18626Handler := new(MockIso18626Handler)
+	prAction := CreatePatronRequestActionService(mockPrRepo, *new(events.EventBus), mockIso18626Handler, lmsCreator)
+	illRequest := iso18626.Request{}
+	mockPrRepo.On("GetPatronRequestById", patronRequestId).Return(pr_db.PatronRequest{IllRequest: illRequest, State: LenderStateValidated, Side: SideLending, SupplierSymbol: getDbText("ISIL:SUP1"), RequesterSymbol: getDbText("ISIL:REQ1")}, nil)
+	action := LenderActionAskRetry
+
+	status, resultData := prAction.handleInvokeAction(appCtx, events.Event{PatronRequestID: patronRequestId, EventData: events.EventData{
+		CommonEventData: events.CommonEventData{Action: &action},
+		CustomData:      map[string]any{},
+	}})
+	assert.Equal(t, events.EventStatusSuccess, status)
+	assert.NotNil(t, resultData)
+	assert.Equal(t, LenderStateCompletedWithRetry, mockPrRepo.savedPr.State)
+
+	if assert.NotNil(t, mockIso18626Handler.lastSupplyingAgencyMessage) {
+		assert.Equal(t, iso18626.TypeStatusRetryPossible, mockIso18626Handler.lastSupplyingAgencyMessage.StatusInfo.Status)
+		assert.Equal(t, string(iso18626.ReasonRetryNotFoundAsCited), mockIso18626Handler.lastSupplyingAgencyMessage.MessageInfo.ReasonRetry.Text)
+		assert.Equal(t, "", mockIso18626Handler.lastSupplyingAgencyMessage.MessageInfo.Note)
+		assert.Nil(t, mockIso18626Handler.lastSupplyingAgencyMessage.MessageInfo.OfferedCosts)
+		assert.Nil(t, mockIso18626Handler.lastSupplyingAgencyMessage.DeliveryInfo)
+	}
+}
+
+func TestHandleInvokeLenderActionAskRetryFull(t *testing.T) {
+	mockPrRepo := new(MockPrRepo)
+	lmsCreator := new(MockLmsCreator)
+	lmsCreator.On("GetAdapter", "ISIL:SUP1").Return(lms.CreateLmsAdapterMockOK(), nil)
+	mockIso18626Handler := new(MockIso18626Handler)
+	prAction := CreatePatronRequestActionService(mockPrRepo, *new(events.EventBus), mockIso18626Handler, lmsCreator)
+	illRequest := iso18626.Request{}
+	mockPrRepo.On("GetPatronRequestById", patronRequestId).Return(pr_db.PatronRequest{IllRequest: illRequest, State: LenderStateValidated, Side: SideLending, SupplierSymbol: getDbText("ISIL:SUP1"), RequesterSymbol: getDbText("ISIL:REQ1")}, nil)
+	action := LenderActionAskRetry
+
+	status, resultData := prAction.handleInvokeAction(appCtx, events.Event{PatronRequestID: patronRequestId, EventData: events.EventData{
+		CommonEventData: events.CommonEventData{Action: &action},
+		CustomData: map[string]any{
+			"note":        "isbn",
+			"itemId":      "0201896834",
+			"reasonRetry": "Transfer",
+		},
+	}})
+	assert.Equal(t, events.EventStatusSuccess, status)
+	assert.NotNil(t, resultData)
+	assert.Equal(t, LenderStateCompletedWithRetry, mockPrRepo.savedPr.State)
+
+	if assert.NotNil(t, mockIso18626Handler.lastSupplyingAgencyMessage) {
+		assert.Equal(t, iso18626.TypeStatusRetryPossible, mockIso18626Handler.lastSupplyingAgencyMessage.StatusInfo.Status)
+		assert.Equal(t, "Transfer", mockIso18626Handler.lastSupplyingAgencyMessage.MessageInfo.ReasonRetry.Text)
+		assert.Equal(t, "isbn", mockIso18626Handler.lastSupplyingAgencyMessage.MessageInfo.Note)
+		assert.Nil(t, mockIso18626Handler.lastSupplyingAgencyMessage.MessageInfo.OfferedCosts)
+		if assert.NotNil(t, mockIso18626Handler.lastSupplyingAgencyMessage.DeliveryInfo) {
+			assert.Equal(t, "0201896834", mockIso18626Handler.lastSupplyingAgencyMessage.DeliveryInfo.ItemId)
+		}
+	}
+}
+
 func TestHandleInvokeLenderActionAddConditionMissingConditionAndCost(t *testing.T) {
 	mockPrRepo := new(MockPrRepo)
 	lmsCreator := new(MockLmsCreator)

broker/patron_request/service/message-handler.go

@@ -229,6 +229,7 @@ func (m *PatronRequestMessageHandler) handleSupplyingAgencyMessageWithParent(ctx
 	}
 
 	eventName := MessageEvent("")
+	retryItemId := ""
 	switch sam.StatusInfo.Status {
 	case iso18626.TypeStatusExpectToSupply:
 		eventName = SupplierExpectToSupply
@@ -267,6 +268,11 @@ func (m *PatronRequestMessageHandler) handleSupplyingAgencyMessageWithParent(ctx
 			}
 			eventName = SupplierCancelAccepted
 		}
+	case iso18626.TypeStatusRetryPossible:
+		eventName = SupplierRetryConditional
+		if sam.DeliveryInfo != nil {
+			retryItemId = sam.DeliveryInfo.ItemId
+		}
 	}
 
 	if eventName == "" {
@@ -283,6 +289,11 @@ func (m *PatronRequestMessageHandler) handleSupplyingAgencyMessageWithParent(ctx
 	if !eventDefined {
 		return statusChangeNotAllowed()
 	}
+	if retryItemId != "" {
+		// needs to be stored in the patron request so it can be used if the requester accepts the retry offer
+		// could be a field on its own (extend the db schema)
+		updatedPr.IllRequest.BibliographicInfo.SupplierUniqueRecordId = retryItemId
+	}
 	return m.updatePatronRequestAndCreateSamResponse(ctx, updatedPr, sam, stateChanged, parentEventID)
 }
 

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"
+	SupplierRetryConditional MessageEvent = "retry-conditional"
+	RequesterCancelRequest   MessageEvent = "cancel-request"
+	RequesterReceived        MessageEvent = "received"
+	RequesterShippedReturn   MessageEvent = "shipped-return"
+	RequesterCondAccepted    MessageEvent = "conditions-accepted"
+	RequesterCondRejected    MessageEvent = "condition-rejected"
 )
 
 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),
 	})
 }