CROSSLINK-188 Add supplier info for all notifications in Opaque mode (#344)

* CROSSLINK-188 Add supplier info for all notifications in Opaque mode

* CROSSLINK-188 Add env var to prepend supplier symbol

* Rephrase

---------

Co-authored-by: Jakub Skoczen <jakub@indexdata.com>

Author: JanisSaldabols

broker/README.md

@@ -63,6 +63,7 @@ Configuration is provided via environment variables:
 | `SUPPLIER_INFO`        | Should `request/supplierInfo` be populated from Directory                                 | `true`                                    |
 | `RETURN_INFO`          | Should `returnInfo` be populated from Directory for supplier `Loaned` message             | `true`                                    |
 | `VENDOR_INFO`          | Should `note` be prepended with `Vendor: xxx` note                                        | `true`                                    |
+| `SUPPLIER_SYMBOL_NOTE` | Should `note` field be prepended with a `Supplier: {symbol}` note                         | `true`                                    |
 | `OFFERED_COSTS`        | Should `deliveryCosts` be transferred to `offeredCosts` for ReShare requesters            | `false`                                   |
 | `NOTE_FIELD_SEP`       | Separator for fields (e.g. Vendor) prepended to the note                                  | `, `                                      |
 | `CLIENT_DELAY`         | Delay duration for outgoing ISO18626 messages                                             | `0ms`                                     |

broker/client/client.go

@@ -42,6 +42,7 @@ var appendSupplierInfo, _ = utils.GetEnvBool("SUPPLIER_INFO", true)
 var appendRequestingAgencyInfo, _ = utils.GetEnvBool("REQ_AGENCY_INFO", true)
 var appendReturnInfo, _ = utils.GetEnvBool("RETURN_INFO", true)
 var prependVendor, _ = utils.GetEnvBool("VENDOR_INFO", true)
+var supplierSymbolNote, _ = utils.GetEnvBool("SUPPLIER_SYMBOL_NOTE", true)
 
 type Iso18626Client struct {
 	eventBus         events.EventBus
@@ -140,7 +141,7 @@ func populateReturnAddress(message *iso18626.ISO18626Message, name string, agenc
 	}
 }
 
-func populateVendor(message *iso18626.SupplyingAgencyMessage, vendor string) {
+func prependVendorNote(message *iso18626.SupplyingAgencyMessage, vendor string) {
 	if message.MessageInfo.Note != "" {
 		sep := shim.NOTE_FIELD_SEP
 		if strings.HasPrefix(message.MessageInfo.Note, "#") {
@@ -675,24 +676,27 @@ func createSupplyingAgencyMessage(trCtx transactionContext, target *messageTarge
 		name, agencyId, address, _ := getPeerInfo(target.peer, target.supplier.SupplierSymbol)
 		populateReturnAddress(message, name, agencyId, address)
 	}
+	if supplierSymbolNote {
+		prependSupplierSymbolNote(trCtx, sam)
+	}
 	if prependVendor && target.firstMessage && target.peer != nil && target.peer.Vendor != trCtx.requester.Vendor {
-		populateVendor(sam, target.peer.Vendor)
+		prependVendorNote(sam, target.peer.Vendor)
 	}
-
-	updateSupplierNote(trCtx, sam)
-
 	return message
 }
 
-func updateSupplierNote(trCtx transactionContext, sam *iso18626.SupplyingAgencyMessage) {
+func prependSupplierSymbolNote(trCtx transactionContext, sam *iso18626.SupplyingAgencyMessage) {
 	if trCtx.requester != nil && trCtx.requester.BrokerMode == string(common.BrokerModeOpaque) &&
-		(sam.StatusInfo.Status == iso18626.TypeStatusExpectToSupply || sam.StatusInfo.Status == iso18626.TypeStatusUnfilled) &&
 		trCtx.selectedSupplier != nil {
 		symbol := strings.SplitN(trCtx.selectedSupplier.SupplierSymbol, ":", 2)
-		note := sam.MessageInfo.Note
-		sam.MessageInfo.Note = "Supplier: " + symbol[1]
-		if note != "" {
-			sam.MessageInfo.Note += ", " + note
+		if sam.MessageInfo.Note != "" {
+			sep := shim.NOTE_FIELD_SEP
+			if strings.HasPrefix(sam.MessageInfo.Note, "#") {
+				sep = ""
+			}
+			sam.MessageInfo.Note = "Supplier: " + symbol[1] + sep + sam.MessageInfo.Note
+		} else {
+			sam.MessageInfo.Note = "Supplier: " + symbol[1]
 		}
 	}
 }

broker/client/client_test.go

@@ -351,18 +351,18 @@ func TestValidateReason(t *testing.T) {
 	assert.Equal(t, iso18626.TypeReasonForMessageStatusRequestResponse, reason)
 }
 
-func TestPopulateVendorInNote(t *testing.T) {
+func TestPrependVendorInNote(t *testing.T) {
 	message := iso18626.ISO18626Message{
 		SupplyingAgencyMessage: &iso18626.SupplyingAgencyMessage{},
 	}
 	message.SupplyingAgencyMessage.MessageInfo.Note = ""
-	populateVendor(message.SupplyingAgencyMessage, "Alma")
+	prependVendorNote(message.SupplyingAgencyMessage, "Alma")
 	assert.Equal(t, message.SupplyingAgencyMessage.MessageInfo.Note, "Vendor: Alma")
 	message.SupplyingAgencyMessage.MessageInfo.Note = "some note"
-	populateVendor(message.SupplyingAgencyMessage, "Alma")
+	prependVendorNote(message.SupplyingAgencyMessage, "Alma")
 	assert.Equal(t, message.SupplyingAgencyMessage.MessageInfo.Note, "Vendor: Alma, some note")
 	message.SupplyingAgencyMessage.MessageInfo.Note = "#special note#"
-	populateVendor(message.SupplyingAgencyMessage, "ReShare")
+	prependVendorNote(message.SupplyingAgencyMessage, "ReShare")
 	assert.Equal(t, message.SupplyingAgencyMessage.MessageInfo.Note, "Vendor: ReShare#special note#")
 }
 
@@ -816,38 +816,38 @@ func TestBlockUnfilled(t *testing.T) {
 	assert.False(t, blockUnfilled(trCtx))
 }
 
-func TestUpdateSupplierNote(t *testing.T) {
+func TestPrependSupplierSymbolNote(t *testing.T) {
 	sam := iso18626.SupplyingAgencyMessage{}
 	trCtx := transactionContext{}
-	updateSupplierNote(trCtx, &sam)
+	prependSupplierSymbolNote(trCtx, &sam)
 	assert.Equal(t, "", sam.MessageInfo.Note)
 
 	requester := ill_db.Peer{BrokerMode: string(common.BrokerModeTransparent)}
 	trCtx.requester = &requester
-	updateSupplierNote(trCtx, &sam)
+	prependSupplierSymbolNote(trCtx, &sam)
 	assert.Equal(t, "", sam.MessageInfo.Note)
 
 	requester.BrokerMode = string(common.BrokerModeOpaque)
-	updateSupplierNote(trCtx, &sam)
+	prependSupplierSymbolNote(trCtx, &sam)
 	assert.Equal(t, "", sam.MessageInfo.Note)
 
 	sam.StatusInfo.Status = iso18626.TypeStatusExpectToSupply
-	updateSupplierNote(trCtx, &sam)
+	prependSupplierSymbolNote(trCtx, &sam)
 	assert.Equal(t, "", sam.MessageInfo.Note)
 
 	supplier := ill_db.LocatedSupplier{SupplierSymbol: "ISIL:SUP1"}
 	trCtx.selectedSupplier = &supplier
-	updateSupplierNote(trCtx, &sam)
+	prependSupplierSymbolNote(trCtx, &sam)
 	assert.Equal(t, "Supplier: SUP1", sam.MessageInfo.Note)
 
 	sam.MessageInfo.Note = "Original note"
-	updateSupplierNote(trCtx, &sam)
+	prependSupplierSymbolNote(trCtx, &sam)
 	assert.Equal(t, "Supplier: SUP1, Original note", sam.MessageInfo.Note)
 
 	sam.StatusInfo.Status = iso18626.TypeStatusUnfilled
-	sam.MessageInfo.Note = "Original note 2"
-	updateSupplierNote(trCtx, &sam)
-	assert.Equal(t, "Supplier: SUP1, Original note 2", sam.MessageInfo.Note)
+	sam.MessageInfo.Note = "#special note#"
+	prependSupplierSymbolNote(trCtx, &sam)
+	assert.Equal(t, "Supplier: SUP1#special note#", sam.MessageInfo.Note)
 }
 
 func TestHandleIllMessage(t *testing.T) {