CROSSLINK-210 Add more search parameters

broker/migrations/019_add_attention_field.down.sql

@@ -0,0 +1,3 @@
+DROP VIEW patron_request_search_view ;
+
+ALTER TABLE patron_request DROP COLUMN needs_attention;

broker/migrations/019_add_attention_field.up.sql

@@ -0,0 +1,24 @@
+ALTER TABLE patron_request ADD COLUMN needs_attention BOOLEAN NOT NULL DEFAULT false;
+
+CREATE OR REPLACE VIEW patron_request_search_view AS
+SELECT
+    pr.*,
+    EXISTS (
+        SELECT 1
+        FROM notification n
+        WHERE n.pr_id = pr.id
+    ) AS has_notification,
+    EXISTS (
+        SELECT 1
+        FROM notification n
+        WHERE n.pr_id = pr.id and cost is not null
+    ) AS has_cost,
+    EXISTS (
+        SELECT 1
+        FROM notification n
+        WHERE n.pr_id = pr.id and acknowledged_at is null
+    ) AS has_unread_notification,
+    pr.ill_request -> 'serviceInfo' ->> 'serviceType' AS service_type,
+    pr.ill_request -> 'serviceInfo' -> 'serviceLevel' ->> '#text' AS service_level,
+    (pr.ill_request -> 'serviceInfo' ->> 'needBeforeDate')::timestamptz AS needed_at
+FROM patron_request pr;

broker/oapi/open-api.yaml

@@ -465,12 +465,16 @@ components:
         requesterRequestId:
           type: string
           description: Requester patron request ID
+        needsAttention:
+          type: boolean
+          description: Indicates if the request needs attention
       required:
         - id
         - timestamp
         - state
         - side
         - illRequest
+        - needsAttention
     PatronRequests:
       type: object
       required:
@@ -1112,6 +1116,11 @@ paths:
   /patron_requests:
     get:
       summary: Retrieve patron requests
+      description: |
+        Use this endpoint to retrieve patron requests. 
+        Query parameter cql can be used to filter the results.
+        With cql you can use these fields state, side, requester_symbol, supplier_symbol, needs_attention, 
+        has_notification, has_cost, has_unread_notification, service_type, service_level, created_at, needed_at.
       tags:
         - patron-requests-api
       parameters:

broker/patron_request/api/api-handler.go

@@ -546,6 +546,7 @@ func toApiPatronRequest(request pr_db.PatronRequest, illRequest iso18626.Request
 		SupplierSymbol:     toString(request.SupplierSymbol),
 		IllRequest:         utils.Must(common.StructToMap(illRequest)),
 		RequesterRequestId: toString(request.RequesterReqID),
+		NeedsAttention:     request.NeedsAttention,
 	}
 }
 

broker/patron_request/db/prcql.go

@@ -36,6 +36,30 @@ func handlePatronRequestsQuery(cqlString string, noBaseArgs int) (pgcql.Query, e
 	f = pgcql.NewFieldString().WithExact()
 	def.AddField("supplier_symbol", f)
 
+	f = pgcql.NewFieldString().WithExact()
+	def.AddField("needs_attention", f)
+
+	f = pgcql.NewFieldString().WithExact()
+	def.AddField("has_notification", f)
+
+	f = pgcql.NewFieldString().WithExact()
+	def.AddField("has_cost", f)
+
+	f = pgcql.NewFieldString().WithExact()
+	def.AddField("has_unread_notification", f)
+
+	f = pgcql.NewFieldString().WithExact()
+	def.AddField("service_type", f)
+
+	f = pgcql.NewFieldString().WithExact()
+	def.AddField("service_level", f)
+
+	nf := pgcql.NewFieldDate().WithColumn("timestamp")
+	def.AddField("created_at", nf)
+
+	nf = pgcql.NewFieldDate()
+	def.AddField("needed_at", nf)
+
 	var parser cql.Parser
 	query, err := parser.Parse(cqlString)
 	if err != nil {
@@ -49,7 +73,7 @@ func (q *Queries) ListPatronRequestsCql(ctx context.Context, db DBTX, arg ListPa
 	if cqlString == nil {
 		return q.ListPatronRequests(ctx, db, arg)
 	}
-	noBaseArgs := 2 // weh have two base arguments: limit and offset
+	noBaseArgs := 2 // we have two base arguments: limit and offset
 	res, err := handlePatronRequestsQuery(*cqlString, noBaseArgs)
 	if err != nil {
 		return nil, err
@@ -76,16 +100,17 @@ func (q *Queries) ListPatronRequestsCql(ctx context.Context, db DBTX, arg ListPa
 	for rows.Next() {
 		var i ListPatronRequestsRow
 		if err := rows.Scan(
-			&i.PatronRequest.ID,
-			&i.PatronRequest.Timestamp,
-			&i.PatronRequest.IllRequest,
-			&i.PatronRequest.State,
-			&i.PatronRequest.Side,
-			&i.PatronRequest.Patron,
-			&i.PatronRequest.RequesterSymbol,
-			&i.PatronRequest.SupplierSymbol,
-			&i.PatronRequest.Tenant,
-			&i.PatronRequest.RequesterReqID,
+			&i.ID,
+			&i.Timestamp,
+			&i.IllRequest,
+			&i.State,
+			&i.Side,
+			&i.Patron,
+			&i.RequesterSymbol,
+			&i.SupplierSymbol,
+			&i.Tenant,
+			&i.RequesterReqID,
+			&i.NeedsAttention,
 			&i.FullCount,
 		); err != nil {
 			return nil, err

broker/patron_request/db/prrepo.go

@@ -69,7 +69,19 @@ func (r *PgPrRepo) ListPatronRequests(ctx common.ExtendedContext, params ListPat
 			fullCount = rows[0].FullCount
 			for _, r := range rows {
 				fullCount = r.FullCount
-				list = append(list, r.PatronRequest)
+				list = append(list, PatronRequest{
+					ID:              r.ID,
+					Timestamp:       r.Timestamp,
+					IllRequest:      r.IllRequest,
+					State:           PatronRequestState(r.State),
+					Side:            PatronRequestSide(r.Side),
+					Patron:          r.Patron,
+					RequesterSymbol: r.RequesterSymbol,
+					SupplierSymbol:  r.SupplierSymbol,
+					Tenant:          r.Tenant,
+					RequesterReqID:  r.RequesterReqID,
+					NeedsAttention:  r.NeedsAttention,
+				})
 			}
 		} else {
 			params.Limit = 1

broker/patron_request/service/action.go

@@ -120,6 +120,9 @@ func (a *PatronRequestActionService) finalizeActionExecution(ctx common.Extended
 		}
 	}
 
+	if execResult.outcome == ActionOutcomeFailure {
+		a.setNeedsAttention(ctx, updatedPr)
+	}
 	return execResult.status, execResult.result
 }
 
@@ -607,6 +610,19 @@ func (a *PatronRequestActionService) checkSupplyingResponse(status events.EventS
 	return actionExecutionResult{status: events.EventStatusSuccess, result: nil, outcome: ActionOutcomeSuccess, pr: pr}
 }
 
+func (a *PatronRequestActionService) setNeedsAttention(ctx common.ExtendedContext, pr pr_db.PatronRequest) {
+	prToUpdate, err := a.prRepo.GetPatronRequestById(ctx, pr.ID)
+	if err != nil {
+		ctx.Logger().Error("failed to read patron request", "error", err)
+		return
+	}
+	prToUpdate.NeedsAttention = true
+	_, err = a.prRepo.UpdatePatronRequest(ctx, pr_db.UpdatePatronRequestParams(prToUpdate))
+	if err != nil {
+		ctx.Logger().Error("failed to update patron request", "error", err)
+	}
+}
+
 type ResponseCaptureWriter struct {
 	IllMessage *iso18626.ISO18626Message
 	StatusCode int