UpdateStockOutLine.r#type remove option

The suggestion

There is an optional struct field UpdateStockOutLine.r#type that results in always throwing an error if you don't provide a value. In which case, it's not optional! So howsabout it isn't?

TANGENT: The front end shouldn't be able to specify the type IMO! Bad frontend code (say a plugin??? We'd NEVER write bad code 😁) could send the wrong type. The backend surely could derive the type from the parent record... it already does various queries figuring how to apply/validate/backdate the request, one more indexed query of invoice surely is negligible!

Example use case

// BEFORE
inline_init(|r: &mut UpdateStockOutLine| {
  r.id = "prescription_stock_out_line1".to_string();
  r.r#type = Some(StockOutType::Prescription);
  r.number_of_packs = Some(10.0);
});

// AFTER
inline_init(|r: &mut UpdateStockOutLine| {
  r.id = "prescription_stock_out_line1".to_string();
  r.r#type =StockOutType::Prescription;
  r.number_of_packs = Some(10.0);
});

// BEFORE 
// THROWS AN ERROR AT RUNTIME BECAUSE YOU DIDN'T SPECIFY A TYPE BECAUSE THE TYPE SYSTEM SAID IT WAS OPTIONAL
inline_init(|r: &mut UpdateStockOutLine| {
  r.id = "prescription_stock_out_line1".to_string();
  r.number_of_packs = Some(10.0);
});

// AFTER
// THE COMPILER TELLS YOU OFF BECAUSE A REQUIRED FIELD (r#type) IS MISSING
inline_init(|r: &mut UpdateStockOutLine| {
  r.id = "prescription_stock_out_line1".to_string();
  r.number_of_packs = Some(10.0);
});

Why should we invest time in this?

Annoying working with an Option when it's mandatory. Slows dev down. Makes mistakes. Type system should prevent mistakes not create them.

Are there any risks associated with this change?

Breaks frontend maybe?

How much effort is required?

I already did it but reverted the commit. 034633acfc21

Agreed Solution

Make r.r#type required?

msupply-foundation / open-msupply