Keys for batch action defaults CROSSLINK-297

Author: skomorokh

broker/oapi/open-api.yaml

@@ -1218,6 +1218,19 @@ components:
         - actionName
         - batchQuery
 
+    BatchActionDefault:
+      title: Batch Action Default
+      description: A built-in batch action that clients can offer as a starting point
+      allOf:
+        - $ref: '#/components/schemas/CreateBatchAction'
+        - type: object
+          properties:
+            titleKey:
+              type: string
+              description: Stable identifier for this default, for clients to look up a localized title
+          required:
+            - titleKey
+
     UpdateBatchAction:
       type: object
       title: Update Batch Action
@@ -2340,7 +2353,7 @@ paths:
               schema:
                 type: array
                 items:
-                  $ref: '#/components/schemas/CreateBatchAction'
+                  $ref: '#/components/schemas/BatchActionDefault'
         '500':
           description: Internal Server Error
           content:

broker/patron_request/api/api-handler_test.go

@@ -974,10 +974,17 @@ func TestGetStateModelBatchActions(t *testing.T) {
 	rr := httptest.NewRecorder()
 	handler.GetStateModelBatchActions(rr, req, proapi.GetStateModelBatchActionsParams{})
 	assert.Equal(t, http.StatusOK, rr.Code)
-	var actions []proapi.CreateBatchAction
+	var actions []proapi.BatchActionDefault
 	err := json.Unmarshal(rr.Body.Bytes(), &actions)
 	assert.NoError(t, err)
 	assert.Len(t, actions, 4)
+	// Clients key translated titles off titleKey, so each default needs a distinct one.
+	seen := map[string]bool{}
+	for _, action := range actions {
+		assert.NotEmpty(t, action.TitleKey)
+		assert.False(t, seen[action.TitleKey], "duplicate titleKey %s", action.TitleKey)
+		seen[action.TitleKey] = true
+	}
 }
 
 type PrRepoError struct {

broker/patron_request/service/statemodel.go

@@ -21,7 +21,7 @@ type StateModelService struct {
 
 type StateModelsConfig struct {
 	StateModels         map[string]proapi.StateModel `json:"stateModels"`
-	BatchActionDefaults []proapi.CreateBatchAction   `json:"batchActionDefaults"`
+	BatchActionDefaults []proapi.BatchActionDefault  `json:"batchActionDefaults"`
 }
 
 func (s *StateModelService) GetStateModel(modelName string) (*proapi.StateModel, error) {
@@ -240,13 +240,13 @@ func hasTransitionTarget(allowedTransitionTargets map[string]struct{}, name stri
 	return ok
 }
 
-func GetStateModelBatchActionDefaults() []proapi.CreateBatchAction {
+func GetStateModelBatchActionDefaults() []proapi.BatchActionDefault {
 	// Return a defensive deep copy so callers can't mutate embedded defaults.
 	data, err := json.Marshal(stateModelsConfig.BatchActionDefaults)
 	if err != nil {
 		return slices.Clone(stateModelsConfig.BatchActionDefaults)
 	}
-	var out []proapi.CreateBatchAction
+	var out []proapi.BatchActionDefault
 	if err := json.Unmarshal(data, &out); err != nil {
 		return slices.Clone(stateModelsConfig.BatchActionDefaults)
 	}

broker/patron_request/service/statemodels/state-models.json

@@ -698,6 +698,7 @@
   "batchActionDefaults": [
     {
       "actionName": "email-pullslips",
+      "titleKey": "email-pullslips",
       "title": "Email pull slips ready to ship",
       "batchQuery": "side = lending and state = WILL_SUPPLY",
       "schedule": "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR;BYHOUR=6;BYMINUTE=0",
@@ -713,6 +714,7 @@
     },
     {
       "actionName": "request-aging",
+      "titleKey": "request-aging-express",
       "title": "Request aging of express requests",
       "batchQuery": "(state = VALIDATED or state = WILL_SUPPLY or state = CONDITION_PENDING or state = NEEDS_REVIEW) and service_level = Express",
       "schedule": "FREQ=MINUTELY;INTERVAL=15",
@@ -722,6 +724,7 @@
     },
     {
       "actionName": "request-aging",
+      "titleKey": "request-aging-rush",
       "title": "Request aging of rush requests",
       "batchQuery": "(state = VALIDATED or state = WILL_SUPPLY or state = CONDITION_PENDING or state = NEEDS_REVIEW) and service_level = Rush",
       "schedule": "FREQ=HOURLY;BYMINUTE=0",
@@ -731,6 +734,7 @@
     },
     {
       "actionName": "request-aging",
+      "titleKey": "request-aging-all",
       "title": "Request aging of all requests",
       "batchQuery": "state = VALIDATED or state = WILL_SUPPLY or state = CONDITION_PENDING or state = NEEDS_REVIEW",
       "schedule": "FREQ=DAILY;BYHOUR=5;BYMINUTE=0",

misc/state-models.yaml

@@ -474,6 +474,7 @@ stateModels:
 
 batchActionDefaults:
   - actionName: email-pullslips
+    titleKey: email-pullslips
     title: Email pull slips ready to ship
     batchQuery: side = lending and state = WILL_SUPPLY
     schedule: "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR;BYHOUR=6;BYMINUTE=0"
@@ -486,20 +487,23 @@ batchActionDefaults:
       isHtml: true
 
   - actionName: request-aging
+    titleKey: request-aging-express
     title: Request aging of express requests
     batchQuery: "(state = VALIDATED or state = WILL_SUPPLY or state = CONDITION_PENDING or state = NEEDS_REVIEW) and service_level = Express"
     schedule: "FREQ=MINUTELY;INTERVAL=15"
     actionParams:
       interval: 2h
 
   - actionName: request-aging
+    titleKey: request-aging-rush
     title: Request aging of rush requests
     batchQuery: "(state = VALIDATED or state = WILL_SUPPLY or state = CONDITION_PENDING or state = NEEDS_REVIEW) and service_level = Rush"
     schedule: "FREQ=HOURLY;BYMINUTE=0"
     actionParams:
       interval: 24h
 
   - actionName: request-aging
+    titleKey: request-aging-all
     title: Request aging of all requests
     batchQuery: state = VALIDATED or state = WILL_SUPPLY or state = CONDITION_PENDING or state = NEEDS_REVIEW
     schedule: "FREQ=DAILY;BYHOUR=5;BYMINUTE=0"