B-21378: Introduce iUB RDD Transit Calculation

pkg/factory/mto_shipment_factory.go

@@ -111,7 +111,11 @@ func buildMTOShipmentWithBuildType(db *pop.Connection, customs []Customization,
 
 		if shipmentHasPickupDetails {
 			newMTOShipment.RequestedPickupDate = models.TimePointer(time.Date(GHCTestYear, time.March, 15, 0, 0, 0, 0, time.UTC))
-			newMTOShipment.ScheduledPickupDate = models.TimePointer(time.Date(GHCTestYear, time.March, 16, 0, 0, 0, 0, time.UTC))
+			if cMtoShipment.ScheduledPickupDate == nil {
+				newMTOShipment.ScheduledPickupDate = models.TimePointer(time.Date(GHCTestYear, time.March, 16, 0, 0, 0, 0, time.UTC))
+			} else {
+				newMTOShipment.ScheduledPickupDate = cMtoShipment.ScheduledPickupDate
+			}
 			newMTOShipment.ActualPickupDate = models.TimePointer(time.Date(GHCTestYear, time.March, 16, 0, 0, 0, 0, time.UTC))
 		}
 
@@ -208,8 +212,12 @@ func buildMTOShipmentWithBuildType(db *pop.Connection, customs []Customization,
 		}
 
 		if cMtoShipment.ScheduledPickupDate != nil {
-			requiredDeliveryDate := time.Date(GHCTestYear, time.April, 15, 0, 0, 0, 0, time.UTC)
-			newMTOShipment.RequiredDeliveryDate = &requiredDeliveryDate
+			if cMtoShipment.RequiredDeliveryDate != nil {
+				newMTOShipment.RequiredDeliveryDate = cMtoShipment.RequiredDeliveryDate
+			} else {
+				requiredDeliveryDate := time.Date(GHCTestYear, time.April, 15, 0, 0, 0, 0, time.UTC)
+				newMTOShipment.RequiredDeliveryDate = &requiredDeliveryDate
+			}
 		}
 	}
 

pkg/handlers/primeapiv3/mto_shipment.go

@@ -225,7 +225,7 @@ func (h UpdateMTOShipmentHandler) Handle(params mtoshipmentops.UpdateMTOShipment
 						payloads.ClientError(handlers.PreconditionErrMessage, err.Error(), h.GetTraceIDFromRequest(params.HTTPRequest))), err
 				default:
 					return mtoshipmentops.NewUpdateMTOShipmentInternalServerError().WithPayload(
-						payloads.InternalServerError(nil, h.GetTraceIDFromRequest(params.HTTPRequest))), err
+						payloads.InternalServerError(handlers.FmtString(err.Error()), h.GetTraceIDFromRequest(params.HTTPRequest))), err
 				}
 			}
 			mtoShipmentPayload := payloads.MTOShipment(mtoShipment)

pkg/models/re_contract_year.go

@@ -71,6 +71,20 @@ func (r *ReContractYear) Validate(_ *pop.Connection) (*validate.Errors, error) {
 	), nil
 }
 
+// This function uses a raw query that calls db function get_contract to get the reContractYearId in respects to the requestedPickupDate
+func FetchContractId(db *pop.Connection, requestedPickupDate time.Time) (uuid.UUID, error) {
+	if !requestedPickupDate.IsZero() {
+		var reContractYearId uuid.UUID
+		err := db.RawQuery("SELECT get_contract_id($1)", requestedPickupDate).First(&reContractYearId)
+		if err != nil {
+			return uuid.Nil, fmt.Errorf("error fetching contract year id for requested pickup date %s", requestedPickupDate)
+		}
+
+		return reContractYearId, nil
+	}
+	return uuid.Nil, fmt.Errorf("error fetching contract ID - required parameters not provided")
+}
+
 func GetExpectedEscalationPriceContractsCount(contractYearName string) (ExpectedEscalationPriceContractsCount, error) {
 	switch contractYearName {
 	case BasePeriodYear1:

pkg/models/re_contract_year_test.go

@@ -6,6 +6,7 @@ import (
 	"github.com/gofrs/uuid"
 
 	"github.com/transcom/mymove/pkg/models"
+	"github.com/transcom/mymove/pkg/testdatagen"
 )
 
 func (suite *ModelSuite) TestReContractYearValidations() {
@@ -52,3 +53,62 @@ func (suite *ModelSuite) TestReContractYearValidations() {
 		suite.verifyValidationErrors(&badDatesReContractYear, expErrors)
 	})
 }
+
+func (suite *ModelSuite) TestReContractYearModel() {
+	suite.Run("test that FetchContractId returns the contractId given a requestedPickupDate", func() {
+		validReContractYear := testdatagen.MakeReContractYear(suite.DB(), testdatagen.Assertions{
+			ReContractYear: models.ReContractYear{
+				Name:                 "Base Period Year 1",
+				StartDate:            time.Date(2019, time.October, 1, 0, 0, 0, 0, time.UTC),
+				EndDate:              time.Date(2020, time.September, 30, 0, 0, 0, 0, time.UTC),
+				Escalation:           1.03,
+				EscalationCompounded: 1.74,
+			},
+		})
+
+		requestedPickupDate := time.Date(2019, time.October, 25, 0, 0, 0, 0, time.UTC)
+		contractYearId, err := models.FetchContractId(suite.DB(), requestedPickupDate)
+
+		suite.Nil(err)
+		suite.NotNil(contractYearId)
+		suite.Equal(contractYearId, validReContractYear.ContractID)
+	})
+
+	suite.Run("test that FetchContractId returns error when no requestedPickupDate is given", func() {
+		testdatagen.MakeReContractYear(suite.DB(), testdatagen.Assertions{
+			ReContractYear: models.ReContractYear{
+				Name:                 "Base Period Year 1",
+				StartDate:            time.Date(2019, time.October, 1, 0, 0, 0, 0, time.UTC),
+				EndDate:              time.Date(2020, time.September, 30, 0, 0, 0, 0, time.UTC),
+				Escalation:           1.03,
+				EscalationCompounded: 1.74,
+			},
+		})
+
+		var time time.Time
+		contractYearId, err := models.FetchContractId(suite.DB(), time)
+
+		suite.NotNil(err)
+		suite.Contains(err.Error(), "error fetching contract ID - required parameters not provided")
+		suite.Equal(contractYearId, uuid.Nil)
+	})
+
+	suite.Run("test that FetchContractId returns error when no contract is found for given requestedPickupDate", func() {
+		testdatagen.MakeReContractYear(suite.DB(), testdatagen.Assertions{
+			ReContractYear: models.ReContractYear{
+				Name:                 "Base Period Year 1",
+				StartDate:            time.Date(2019, time.October, 1, 0, 0, 0, 0, time.UTC),
+				EndDate:              time.Date(2020, time.September, 30, 0, 0, 0, 0, time.UTC),
+				Escalation:           1.03,
+				EscalationCompounded: 1.74,
+			},
+		})
+		requestedPickupDate := time.Date(2019, time.September, 1, 0, 0, 0, 0, time.UTC)
+
+		contractYearId, err := models.FetchContractId(suite.DB(), requestedPickupDate)
+
+		suite.NotNil(err)
+		suite.Contains(err.Error(), "error fetching contract year id")
+		suite.Equal(contractYearId, uuid.Nil)
+	})
+}

pkg/models/re_intl_transit_times.go

@@ -3,7 +3,10 @@ package models
 import (
 	"time"
 
+	"github.com/gobuffalo/pop/v6"
 	"github.com/gofrs/uuid"
+
+	"github.com/transcom/mymove/pkg/apperror"
 )
 
 type InternationalTransitTime struct {
@@ -20,3 +23,17 @@ type InternationalTransitTime struct {
 func (InternationalTransitTime) TableName() string {
 	return "re_intl_transit_times"
 }
+
+// fetch the re_intl_transit_time record from the db
+func FetchInternationalTransitTime(db *pop.Connection, originRateAreaId uuid.UUID, destinationRateAreaId uuid.UUID) (InternationalTransitTime, error) {
+	var internationalTransitTime InternationalTransitTime
+	err := db.
+		Where("origin_rate_area_id = $1 and destination_rate_area_id = $2", originRateAreaId, destinationRateAreaId).
+		First(&internationalTransitTime)
+
+	if err != nil {
+		return internationalTransitTime, apperror.NewQueryError("InternationalTransitTime", err, "could not look up intl transit time")
+	}
+
+	return internationalTransitTime, nil
+}

pkg/models/re_intl_transit_times_test.go

@@ -0,0 +1,21 @@
+package models_test
+
+import (
+	"github.com/gofrs/uuid"
+
+	"github.com/transcom/mymove/pkg/models"
+)
+
+func (suite *ModelSuite) TestIntlTransitTimesModel() {
+	suite.Run("test that FetchInternationalTransitTime returns the re_intl_transit_times given an originRateAreaId and a destinationRateAreaId", func() {
+		originRateAreaId := uuid.FromStringOrNil("6e802149-7e46-4d7a-ab57-6c4df832085d")
+		destinationRateAreaId := uuid.FromStringOrNil("c18e25f9-ec34-41ca-8c1b-05558c8d6364")
+
+		fetchedIntlTransitTime, err := models.FetchInternationalTransitTime(suite.DB(), originRateAreaId, destinationRateAreaId)
+
+		suite.Nil(err)
+		suite.NotNil(fetchedIntlTransitTime)
+		suite.Equal(originRateAreaId, fetchedIntlTransitTime.OriginRateAreaId)
+		suite.Equal(destinationRateAreaId, fetchedIntlTransitTime.DestinationRateAreaId)
+	})
+}

pkg/models/re_rate_area_test.go

@@ -42,8 +42,11 @@ func (suite *ModelSuite) TestFetchRateAreaID() {
 	})
 
 	suite.Run("fail - receive error when not all values are provided", func() {
-		address := factory.BuildAddress(suite.DB(), nil, nil)
-		rateAreaId, err := models.FetchRateAreaID(suite.DB(), address.ID, nil, uuid.Nil)
+		var nilUuid uuid.UUID
+		nonNilUuid := uuid.Must(uuid.NewV4())
+		contract := testdatagen.FetchOrMakeReContract(suite.DB(), testdatagen.Assertions{})
+		rateAreaId, err := models.FetchRateAreaID(suite.DB(), nilUuid, &nonNilUuid, contract.ID)
+
 		suite.Equal(uuid.Nil, rateAreaId)
 		suite.Error(err)
 	})

pkg/services/mto_shipment/mto_shipment_updater.go

@@ -848,6 +848,16 @@ func (f *mtoShipmentUpdater) updateShipmentRecord(appCtx appcontext.AppContext,
 			newShipment = models.DetermineShipmentMarketCode(newShipment)
 		}
 
+		// RDD for UB shipments only need the pick up date, shipment origin address and destination address to determine required delivery date
+		if newShipment.ScheduledPickupDate != nil && !newShipment.ScheduledPickupDate.IsZero() && newShipment.ShipmentType == models.MTOShipmentTypeUnaccompaniedBaggage {
+			calculatedRDD, err := CalculateRequiredDeliveryDateForInternationalShipment(appCtx, *newShipment.PickupAddress, *newShipment.DestinationAddress, *newShipment.ScheduledPickupDate, newShipment.ShipmentType)
+			if err != nil {
+				return err
+			}
+
+			newShipment.RequiredDeliveryDate = &calculatedRDD
+		}
+
 		if err := txnAppCtx.DB().Update(newShipment); err != nil {
 			return err
 		}
@@ -1042,6 +1052,7 @@ func (o *mtoShipmentStatusUpdater) createShipmentServiceItems(appCtx appcontext.
 func (o *mtoShipmentStatusUpdater) setRequiredDeliveryDate(appCtx appcontext.AppContext, shipment *models.MTOShipment) error {
 	if shipment.ScheduledPickupDate != nil &&
 		shipment.RequiredDeliveryDate == nil &&
+		shipment.ShipmentType != models.MTOShipmentTypeUnaccompaniedBaggage &&
 		(shipment.PrimeEstimatedWeight != nil || shipment.NTSRecordedWeight != nil) {
 
 		var pickupLocation *models.Address
@@ -1081,6 +1092,13 @@ func (o *mtoShipmentStatusUpdater) setRequiredDeliveryDate(appCtx appcontext.App
 		}
 
 		shipment.RequiredDeliveryDate = requiredDeliveryDate
+	} else if shipment.ShipmentType == models.MTOShipmentTypeUnaccompaniedBaggage && shipment.ScheduledPickupDate != nil && !shipment.ScheduledDeliveryDate.IsZero() {
+		requiredDeliveryDate, calcErr := CalculateRequiredDeliveryDateForInternationalShipment(appCtx, *shipment.PickupAddress, *shipment.DestinationAddress, *shipment.ScheduledPickupDate, shipment.ShipmentType)
+		if calcErr != nil {
+			return calcErr
+		}
+
+		shipment.RequiredDeliveryDate = &requiredDeliveryDate
 	}
 
 	return nil
@@ -1273,6 +1291,41 @@ func CalculateRequiredDeliveryDate(appCtx appcontext.AppContext, planner route.P
 	return &requiredDeliveryDate, nil
 }
 
+// CalculateRequiredDeliveryDateForInternationalShipment function is used to get the Required delivery Date of a UB shipment by finding the re_intl_transit_time using the origin and destination address rate areas.
+// The transit time is then added to the day after the pickup date then that date is used as the required delivery date for the UB shipment.
+func CalculateRequiredDeliveryDateForInternationalShipment(appCtx appcontext.AppContext, pickupAddress models.Address, destinationAddress models.Address, pickupDate time.Time, shipmentType models.MTOShipmentType) (time.Time, error) {
+
+	// Transit times does not include the pickup date. Setting the required delivery date to the day after pickup date
+	rdd := pickupDate.AddDate(0, 0, 1)
+
+	// get the contract id
+	contractID, err := models.FetchContractId(appCtx.DB(), pickupDate)
+	if err != nil {
+		return rdd, err
+	}
+
+	// get the rate area id for the origin address
+	originRateAreaID, err := models.FetchRateAreaID(appCtx.DB(), pickupAddress.ID, nil, contractID)
+	if err != nil {
+		return rdd, err
+	}
+
+	// get the rate area id for the destination address
+	destRateAreaID, err := models.FetchRateAreaID(appCtx.DB(), destinationAddress.ID, nil, contractID)
+	if err != nil {
+		return rdd, err
+	}
+
+	// lookup the intl transit time
+	internationalTransitTime, err := models.FetchInternationalTransitTime(appCtx.DB(), originRateAreaID, destRateAreaID)
+	if err != nil {
+		return rdd, err
+	}
+
+	// rdd plus the intl ub transit time
+	return rdd.AddDate(0, 0, *internationalTransitTime.UbTransitTime), nil
+}
+
 // This private function is used to generically construct service items when shipments are approved.
 func constructMTOServiceItemModels(shipmentID uuid.UUID, mtoID uuid.UUID, reServiceCodes []models.ReServiceCode) models.MTOServiceItems {
 	serviceItems := make(models.MTOServiceItems, len(reServiceCodes))