feat(importer/ynab-import): automatically use existing accounts with matching names (#685)

Author: morremeyer

pkg/controllers/import.go

@@ -143,9 +143,8 @@ func (co Controller) ImportYnabImportPreview(c *gin.Context) {
 		return
 	}
 
-	if transactions, ok = duplicateTransactions(co, transactions); !ok {
-		return
-	}
+	transactions = duplicateTransactions(co, transactions)
+	transactions = findAccounts(co, transactions, account.BudgetID)
 
 	c.JSON(http.StatusOK, ImportPreviewList{Data: transactions})
 }
@@ -243,7 +242,7 @@ func getUploadedFile(c *gin.Context, suffix string) (multipart.File, bool) {
 // duplicateTransactions finds duplicate transactions by their import hash. For all input resources,
 // existing resources with the same import hash are searched. If any exist, their IDs are set in the
 // DuplicateTransactionIDs field.
-func duplicateTransactions(co Controller, transactions []importer.TransactionPreview) ([]importer.TransactionPreview, bool) {
+func duplicateTransactions(co Controller, transactions []importer.TransactionPreview) []importer.TransactionPreview {
 	for k, transaction := range transactions {
 		var duplicates []models.Transaction
 		co.DB.Find(&duplicates, models.Transaction{
@@ -263,5 +262,51 @@ func duplicateTransactions(co Controller, transactions []importer.TransactionPre
 		transactions[k] = transaction
 	}
 
-	return transactions, true
+	return transactions
+}
+
+// findAccounts sets the source or destination account ID for a TransactionPreview resource
+// if there is exactly one account with a matching name.
+func findAccounts(co Controller, transactions []importer.TransactionPreview, budgetID uuid.UUID) []importer.TransactionPreview {
+	for k, transaction := range transactions {
+		// Find the right account name
+		name := transaction.DestinationAccountName
+		if transaction.SourceAccountName != "" {
+			name = transaction.SourceAccountName
+		}
+
+		var accounts []models.Account
+		co.DB.Where(models.Account{
+			AccountCreate: models.AccountCreate{
+				Name:     name,
+				BudgetID: budgetID,
+				Hidden:   false,
+			},
+		},
+			// Explicitly specfiy search fields since we use a zero value for Hidden
+			"Name", "BudgetID", "Hidden").Find(&accounts)
+
+		// We cannot determine correctly which account should be used if there are
+		// multiple accounts, therefore we skip
+		//
+		// We also continue if no accounts are found
+		if len(accounts) != 1 {
+			continue
+		}
+
+		// Set source or destination, depending on which one we checked for
+		if accounts[0].ID != uuid.Nil {
+			if transaction.SourceAccountName != "" {
+				transaction.Transaction.SourceAccountID = accounts[0].ID
+				transaction.SourceAccountName = ""
+			} else {
+				transaction.Transaction.DestinationAccountID = accounts[0].ID
+				transaction.DestinationAccountName = ""
+			}
+		}
+
+		transactions[k] = transaction
+	}
+
+	return transactions
 }

pkg/controllers/import_test.go

@@ -155,25 +155,25 @@ func (suite *TestSuiteStandard) TestYnabImportPreviewDuplicateDetection() {
 	account := suite.createTestAccount(models.AccountCreate{})
 
 	// Get the import hash of the first transaction and create one with the same import hash
-	preview := parseComdirectTestCSV(suite, account.Data.ID)
+	preview := parseCSV(suite, account.Data.ID, "comdirect-ynap.csv")
 
 	transaction := suite.createTestTransaction(models.TransactionCreate{
 		SourceAccountID: account.Data.ID,
 		ImportHash:      preview.Data[0].Transaction.ImportHash,
 		Amount:          decimal.NewFromFloat(1.13),
 	})
 
-	preview = parseComdirectTestCSV(suite, account.Data.ID)
+	preview = parseCSV(suite, account.Data.ID, "comdirect-ynap.csv")
 
 	suite.Assert().Len(preview.Data[0].DuplicateTransactionIDs, 1, "Duplicate transaction IDs field does not have the correct number of IDs")
 	suite.Assert().Equal(transaction.Data.ID, preview.Data[0].DuplicateTransactionIDs[0], "Duplicate transaction ID is not ID of the transaction that is duplicated")
 }
 
-func parseComdirectTestCSV(suite *TestSuiteStandard, accountID uuid.UUID) controllers.ImportPreviewList {
+func parseCSV(suite *TestSuiteStandard, accountID uuid.UUID, file string) controllers.ImportPreviewList {
 	path := fmt.Sprintf("ynab-import-preview?accountId=%s", accountID.String())
 
 	// Parse the test CSV
-	body, headers := suite.loadTestFile("importer/ynab-import/comdirect-ynap.csv")
+	body, headers := suite.loadTestFile(fmt.Sprintf("importer/ynab-import/%s", file))
 	recorder := test.Request(suite.controller, suite.T(), http.MethodPost, fmt.Sprintf("http://example.com/v1/import/%s", path), body, headers)
 	suite.Assert().Equal(http.StatusOK, recorder.Code, "Request ID %s, response %s", recorder.Header().Get("x-request-id"), recorder.Body.String())
 
@@ -183,3 +183,55 @@ func parseComdirectTestCSV(suite *TestSuiteStandard, accountID uuid.UUID) contro
 
 	return response
 }
+
+func (suite *TestSuiteStandard) TestYnabImportFindAccounts() {
+	// Create a budget and two existing accounts to use
+	budget := suite.createTestBudget(models.BudgetCreate{})
+	edeka := suite.createTestAccount(models.AccountCreate{BudgetID: budget.Data.ID, Name: "Edeka", External: true})
+
+	// Create an archived account named "Edeka" to ensure it is not found. If it were found, the tests for the non-archived
+	// account being found would fail since we do not use an account if we find more than one with the same name
+	_ = suite.createTestAccount(models.AccountCreate{BudgetID: budget.Data.ID, Name: "Edeka", Hidden: true})
+
+	// Create an account named "Edeka" in another budget to ensure it is not found. If it were found, the tests for the non-archived
+	// Edeka account being found would fail since we do not use an account if we find more than one with the same name
+	_ = suite.createTestAccount(models.AccountCreate{Name: "Edeka"})
+
+	// Account we import to
+	internalAccount := suite.createTestAccount(models.AccountCreate{BudgetID: budget.Data.ID, Name: "Envelope Zero Account"})
+
+	tests := []struct {
+		name                    string      // Name of the test
+		sourceAccountIDs        []uuid.UUID // The IDs of the source accounts
+		sourceAccountNames      []string    // The sourceAccountName attribute after the find has been performed
+		destinationAccountIDs   []uuid.UUID // The IDs of the destination accounts
+		destinationAccountNames []string    // The destinationAccountName attribute after the find has been performed
+		preTest                 func()      // Function to execute before running tests
+	}{
+		{"No matching (Some Company) & 1 Matching (Edeka) accounts", []uuid.UUID{internalAccount.Data.ID, internalAccount.Data.ID, uuid.Nil}, []string{"", "", "Some Company"}, []uuid.UUID{edeka.Data.ID, uuid.Nil, internalAccount.Data.ID}, []string{"", "Deutsche Bahn", ""}, func() {}},
+		{"Two matching non-archived accounts", []uuid.UUID{internalAccount.Data.ID, internalAccount.Data.ID, uuid.Nil}, []string{"", "", "Some Company"}, []uuid.UUID{uuid.Nil, uuid.Nil, internalAccount.Data.ID}, []string{"Edeka", "Deutsche Bahn", ""}, func() {
+			_ = suite.createTestAccount(models.AccountCreate{BudgetID: budget.Data.ID, Name: "Edeka"})
+		}},
+	}
+
+	for _, tt := range tests {
+		suite.T().Run(tt.name, func(t *testing.T) {
+			tt.preTest()
+			preview := parseCSV(suite, internalAccount.Data.ID, "account-find-test.csv")
+
+			for i, transaction := range preview.Data {
+				line := i + 1
+				assert.Equal(t, tt.sourceAccountNames[i], transaction.SourceAccountName, "sourceAccountName does not match in line %d", line)
+				assert.Equal(t, tt.destinationAccountNames[i], transaction.DestinationAccountName, "destinationAccountName does not match in line %d", line)
+
+				if tt.sourceAccountIDs[i] != uuid.Nil {
+					assert.Equal(t, tt.sourceAccountIDs[i], transaction.Transaction.SourceAccountID, "sourceAccountID does not match in line %d", line)
+				}
+
+				if tt.destinationAccountIDs[i] != uuid.Nil {
+					assert.Equal(t, tt.destinationAccountIDs[i], transaction.Transaction.DestinationAccountID, "destinationAccountID does not match in line %d", line)
+				}
+			}
+		})
+	}
+}

testdata/importer/ynab-import/account-find-test.csv

@@ -0,0 +1,4 @@
+Date,Payee,Memo,Outflow,Inflow
+04/01/2019,Edeka,Test,59.97,
+04/01/2019,Deutsche Bahn,Train ticket,80.00,
+04/25/2019,Some Company,Salary April 2019,,2350