fix: unarchiving an envelope now also unarchives its parent category (#726)

Resolves #687.

Author: morremeyer

pkg/models/database.go

@@ -19,6 +19,8 @@ func Migrate(db *gorm.DB) error {
 		/*
 		 * Workaround for https://github.com/go-gorm/gorm/issues/5968
 		 * Remove with 3.0.0
+		 *
+		 * With this, remove the e.UUID != uuid.Nil check in the Envelope.BeforeUpdate method
 		 */
 		// Account
 		db.Unscoped().Model(&Account{}).Select("OnBudget").Where("accounts.on_budget IS NULL").Update("OnBudget", false),
@@ -36,10 +38,10 @@ func Migrate(db *gorm.DB) error {
 		// Delete allocations with an amount of 0
 		db.Unscoped().Model(&Allocation{}).Where("amount IS '0'").Delete(&Allocation{}),
 	}
-	for _, query := range queries {
+	for i, query := range queries {
 		err = query.Error
 		if err != nil {
-			return fmt.Errorf("error during DB migration: %w", err)
+			return fmt.Errorf("error during DB migration for migration %d: %w", i+1, err)
 		}
 	}
 

pkg/models/envelope.go

@@ -36,6 +36,29 @@ func (e Envelope) Self() string {
 	return "Envelope"
 }
 
+// BeforeUpdate verifies the state of the envelope before
+// committing an update to the database.
+func (e *Envelope) BeforeUpdate(tx *gorm.DB) (err error) {
+	// If the archival state is updated from archived to unarchived and the category is
+	// archived, unarchive the category, too.
+	//
+	// This checks for the envelope's ID to not be nil since there is a call during migration
+	// where it is nil. Remove this with v3.0.0 when these migrations are removed, too.
+	if e.ID != uuid.Nil && !e.Hidden {
+		var category Category
+		err = tx.First(&category, e.CategoryID).Error
+		if err != nil {
+			return
+		}
+
+		if category.Hidden {
+			tx.Model(&category).Updates(map[string]any{"hidden": false})
+		}
+	}
+
+	return
+}
+
 func (e *Envelope) AfterFind(tx *gorm.DB) (err error) {
 	e.links(tx)
 	return
@@ -45,6 +68,7 @@ func (e *Envelope) AfterFind(tx *gorm.DB) (err error) {
 // query the resource directly after creating or updating it.
 func (e *Envelope) AfterSave(tx *gorm.DB) (err error) {
 	e.links(tx)
+
 	return
 }
 

pkg/models/envelope_test.go

@@ -267,3 +267,27 @@ func (suite *TestSuiteStandard) TestEnvelopeMonthBalance() {
 		})
 	}
 }
+
+// TestEnvelopeUnarchiveUnarchivesCategory tests that when an envelope is unarchived, but its parent category
+// is archived, the parent category is unarchived, too.
+func (suite *TestSuiteStandard) TestEnvelopeUnarchiveUnarchivesCategory() {
+	budget := suite.createTestBudget(models.BudgetCreate{})
+	category := suite.createTestCategory(models.CategoryCreate{
+		BudgetID: budget.ID,
+		Hidden:   true,
+	})
+
+	envelope := suite.createTestEnvelope(models.EnvelopeCreate{
+		CategoryID: category.ID,
+		Name:       "TestEnvelopeUnarchiveUnarchivesCategory",
+		Hidden:     true,
+	})
+
+	// Unarchive the envelope
+	envelope.Hidden = false
+	suite.db.Save(&envelope)
+
+	// Reload the category
+	suite.db.First(&category, category.ID)
+	assert.False(suite.T(), category.Hidden, "Category should be unarchived when child envelope is unarchived")
+}