feat: import overspendingHandling config from YNAB4

Author: morremeyer

pkg/importer/creator.go

@@ -78,6 +78,7 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err
 		}
 	}
 
+	// Create allocations
 	for _, a := range resources.Allocations {
 		allocation := a.Model
 		allocation.AllocationCreate.EnvelopeID = resources.Categories[a.Category].Envelopes[a.Envelope].Model.ID
@@ -89,6 +90,18 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err
 		}
 	}
 
+	// Create MonthConfigs
+	for _, m := range resources.MonthConfigs {
+		mConfig := m.Model
+		mConfig.EnvelopeID = resources.Categories[m.Category].Envelopes[m.Envelope].Model.ID
+
+		err := tx.Create(&mConfig).Error
+		if err != nil {
+			tx.Rollback()
+			return err
+		}
+	}
+
 	// No errors happened, commit the transaction
 	tx.Commit()
 	return nil

pkg/importer/parser/ynab4/parse.go

@@ -62,7 +62,7 @@ func Parse(f io.Reader) (types.ParsedResources, error) {
 		return types.ParsedResources{}, fmt.Errorf("error parsing transactions: %w", err)
 	}
 
-	err = parseAllocations(&resources, budget.MonthlyBudgets, envelopeIDNames)
+	err = parseMonthlyBudgets(&resources, budget.MonthlyBudgets, envelopeIDNames)
 	if err != nil {
 		return types.ParsedResources{}, fmt.Errorf("error parsing budget allocations: %w", err)
 	}
@@ -339,29 +339,55 @@ func parseTransactions(resources *types.ParsedResources, transactions []Transact
 	return nil
 }
 
-func parseAllocations(resources *types.ParsedResources, allocations []MonthlyBudget, envelopeIDNames IDToEnvelopes) error {
-	for _, monthBudget := range allocations {
+func parseMonthlyBudgets(resources *types.ParsedResources, monthlyBudgets []MonthlyBudget, envelopeIDNames IDToEnvelopes) error {
+	for _, monthBudget := range monthlyBudgets {
 		month, err := time.Parse("2006-01-02", monthBudget.Month)
 		if err != nil {
 			return fmt.Errorf("could not parse date: %w", err)
 		}
 
-		for _, allocation := range monthBudget.MonthlySubCategoryBudgets {
-			// Ignore the ones that are zero
-			if allocation.Budgeted.IsZero() {
-				continue
+		for _, subCategoryBudget := range monthBudget.MonthlySubCategoryBudgets {
+			// If something is budgeted, create an allocation for it
+			if !subCategoryBudget.Budgeted.IsZero() {
+				resources.Allocations = append(resources.Allocations, types.Allocation{
+					Model: models.Allocation{
+						AllocationCreate: models.AllocationCreate{
+							Month:  month,
+							Amount: subCategoryBudget.Budgeted,
+						},
+					},
+					Category: envelopeIDNames[subCategoryBudget.CategoryID].Category,
+					Envelope: envelopeIDNames[subCategoryBudget.CategoryID].Envelope,
+				})
 			}
 
-			resources.Allocations = append(resources.Allocations, types.Allocation{
-				Model: models.Allocation{
-					AllocationCreate: models.AllocationCreate{
-						Month:  month,
-						Amount: allocation.Budgeted,
+			// If the overspendHandling is configured, work with it
+			if !(subCategoryBudget.OverspendingHandling == "") {
+				// This might actually be needed in some use cases, but I could not find one
+				// when implementing, so we're skipping it here.
+				if strings.HasPrefix(subCategoryBudget.CategoryID, "Category/PreYNABDebt") {
+					continue
+				}
+
+				// There's two modes in YNAB4: Confined, which equals AFFECT_ENVELOPE in EZ
+				// and "AffectsBuffer", which equals AFFECT_AVAILABLE in EZ.
+				// Since AFFECT_AVAILABLE is the default, we can skip everything that does not
+				// lead to AFFECT_ENVELOPE.
+				if subCategoryBudget.OverspendingHandling != "Confined" {
+					continue
+				}
+
+				resources.MonthConfigs = append(resources.MonthConfigs, types.MonthConfig{
+					Model: models.MonthConfig{
+						MonthConfigCreate: models.MonthConfigCreate{
+							OverspendMode: "AFFECT_ENVELOPE",
+						},
+						Month: month,
 					},
-				},
-				Category: envelopeIDNames[allocation.CategoryID].Category,
-				Envelope: envelopeIDNames[allocation.CategoryID].Envelope,
-			})
+					Category: envelopeIDNames[subCategoryBudget.CategoryID].Category,
+					Envelope: envelopeIDNames[subCategoryBudget.CategoryID].Envelope,
+				})
+			}
 		}
 	}
 

pkg/importer/parser/ynab4/types.go

@@ -84,7 +84,7 @@ type Transaction struct {
 
 type MonthlySubCategoryBudget struct {
 	Budgeted             decimal.Decimal `json:"budgeted"`
-	OverspendingHandling string          `json:"overspendingHandling"` // Unused. Needed when implementing https://github.com/envelope-zero/backend/issues/327
+	OverspendingHandling string          `json:"overspendingHandling"`
 	CategoryID           string          `json:"categoryId"`
 }
 

pkg/importer/types/types.go

@@ -11,6 +11,7 @@ type ParsedResources struct {
 	Categories   map[string]Category
 	Allocations  []Allocation
 	Transactions []Transaction
+	MonthConfigs []MonthConfig
 }
 
 type Account struct {
@@ -32,6 +33,12 @@ type Allocation struct {
 	Envelope string
 }
 
+type MonthConfig struct {
+	Model    models.MonthConfig
+	Category string // There is a category here since an envelope with the same name can exist for multiple categories
+	Envelope string
+}
+
 type Transaction struct {
 	Model              models.Transaction
 	SourceAccount      string