The personal finance app for everyone
Feature: Add the ability to "revert" a CSV import (#1814)
Zach Gollwitzer536c82f2aab2
diff --git a/app/controllers/imports_controller.rb b/app/controllers/imports_controller.rbindex 8d311215..caee3328 100644--- a/app/controllers/imports_controller.rb+++ b/app/controllers/imports_controller.rb@@ -1,5 +1,5 @@class ImportsController < ApplicationController- before_action :set_import, only: %i[show publish destroy]+ before_action :set_import, only: %i[show publish destroy revert]def publish@import.publish_later@@ -31,6 +31,11 @@ class ImportsController < ApplicationControllerendend+ def revert+ @import.revert_later+ redirect_to imports_path, notice: "Import is reverting in the background."+ end+def destroy@import.destroydiff --git a/app/jobs/revert_import_job.rb b/app/jobs/revert_import_job.rbnew file mode 100644index 00000000..ac7090b4--- /dev/null+++ b/app/jobs/revert_import_job.rb@@ -0,0 +1,7 @@+class RevertImportJob < ApplicationJob+ queue_as :latency_low++ def perform(import)+ import.revert+ end+enddiff --git a/app/models/demo/generator.rb b/app/models/demo/generator.rbindex c20bfa70..22038857 100644--- a/app/models/demo/generator.rb+++ b/app/models/demo/generator.rb@@ -24,7 +24,7 @@ class Demo::Generatorputs "Data cleared"family_names.each_with_index do |family_name, index|- create_family_and_user!(family_name, "user#{index == 0 ? "" : index + 1}@maybe.local", data_enrichment_enabled: index == 0)+ create_family_and_user!(family_name, "user#{index == 0 ? "" : index + 1}@maybe.local")endputs "Users reset"diff --git a/app/models/import.rb b/app/models/import.rbindex 15646d44..472b5e12 100644--- a/app/models/import.rb+++ b/app/models/import.rb@@ -6,7 +6,14 @@ class Import < ApplicationRecordscope :ordered, -> { order(created_at: :desc) }- enum :status, { pending: "pending", complete: "complete", importing: "importing", failed: "failed" }, validate: true+ enum :status, {+ pending: "pending",+ complete: "complete",+ importing: "importing",+ reverting: "reverting",+ revert_failed: "revert_failed",+ failed: "failed"+ }, validate: true, default: "pending"validates :type, inclusion: { in: TYPES }validates :col_sep, inclusion: { in: [ ",", ";" ] }@@ -35,6 +42,27 @@ class Import < ApplicationRecordupdate! status: :failed, error: error.messageend+ def revert_later+ raise "Import is not revertable" unless revertable?++ update! status: :reverting++ RevertImportJob.perform_later(self)+ end++ def revert+ Import.transaction do+ accounts.destroy_all+ entries.destroy_all+ end++ family.sync++ update! status: :pending+ rescue => error+ update! status: :revert_failed, error: error.message+ end+def csv_rows@csv_rows ||= parsed_csvend@@ -113,6 +141,10 @@ class Import < ApplicationRecordcleaned? && mappings.all?(&:valid?)end+ def revertable?+ complete? || revert_failed?+ end+def has_unassigned_account?mappings.accounts.where(key: "").any?enddiff --git a/app/views/import/configurations/_account_import.html.erb b/app/views/import/configurations/_account_import.html.erbindex 2e2a5cd3..afcd3e8b 100644--- a/app/views/import/configurations/_account_import.html.erb+++ b/app/views/import/configurations/_account_import.html.erb@@ -4,6 +4,7 @@<%= form.select :entity_type_col_label, import.csv_headers, { include_blank: "Leave empty", label: "Entity Type" } %><%= form.select :name_col_label, import.csv_headers, { include_blank: "Leave empty", label: "Name (optional)" } %><%= form.select :amount_col_label, import.csv_headers, { include_blank: "Leave empty", label: "Balance" } %>+ <%= form.select :currency_col_label, import.csv_headers, { include_blank: "Leave empty", label: "Currency" } %><%= form.submit "Apply configuration", class: "w-full btn btn--primary", disabled: import.complete? %><% end %>diff --git a/app/views/import/configurations/_mint_import.html.erb b/app/views/import/configurations/_mint_import.html.erbindex f5ff4834..d0eeced4 100644--- a/app/views/import/configurations/_mint_import.html.erb+++ b/app/views/import/configurations/_mint_import.html.erb@@ -16,6 +16,8 @@<%= form.select :signage_convention, [["Incomes are negative", "inflows_negative"], ["Incomes are positive", "inflows_positive"]], { label: true }, disabled: import.complete? %></div>+ <%= form.select :currency_col_label, import.csv_headers, { include_blank: "Leave empty", label: "Currency" }, disabled: import.complete? %>+<%= form.select :account_col_label, import.csv_headers, { include_blank: "Leave empty", label: "Account (optional)" }, disabled: import.complete? %><%= form.select :name_col_label, import.csv_headers, { include_blank: "Leave empty", label: "Name (optional)" }, disabled: import.complete? %><%= form.select :category_col_label, import.csv_headers, { include_blank: "Leave empty", label: "Category (optional)" }, disabled: import.complete? %>diff --git a/app/views/import/configurations/_trade_import.html.erb b/app/views/import/configurations/_trade_import.html.erbindex 278debf8..b8dab627 100644--- a/app/views/import/configurations/_trade_import.html.erb+++ b/app/views/import/configurations/_trade_import.html.erb@@ -11,6 +11,8 @@<%= form.select :signage_convention, [["Buys are positive qty", "inflows_positive"], ["Buys are negative qty", "inflows_negative"]], label: true %></div>+ <%= form.select :currency_col_label, import.csv_headers, { include_blank: "Leave empty", label: "Currency" } %>+<%= form.select :ticker_col_label, import.csv_headers, { include_blank: "Leave empty", label: "Ticker" } %><%= form.select :price_col_label, import.csv_headers, { include_blank: "Leave empty", label: "Price" } %><%= form.select :account_col_label, import.csv_headers, { include_blank: "Leave empty", label: "Account (optional)" } %>diff --git a/app/views/import/configurations/_transaction_import.html.erb b/app/views/import/configurations/_transaction_import.html.erbindex fc741c85..82abb1c5 100644--- a/app/views/import/configurations/_transaction_import.html.erb+++ b/app/views/import/configurations/_transaction_import.html.erb@@ -11,6 +11,8 @@<%= form.select :signage_convention, [["Incomes are positive", "inflows_positive"], ["Incomes are negative", "inflows_negative"]], label: true %></div>+ <%= form.select :currency_col_label, import.csv_headers, { include_blank: "Leave empty", label: "Currency" } %>+<%= form.select :account_col_label, import.csv_headers, { include_blank: "Leave empty", label: "Account (optional)" } %><%= form.select :name_col_label, import.csv_headers, { include_blank: "Leave empty", label: "Name (optional)" } %><%= form.select :category_col_label, import.csv_headers, { include_blank: "Leave empty", label: "Category (optional)" } %>diff --git a/app/views/imports/_import.html.erb b/app/views/imports/_import.html.erbindex 6620f3b9..edffa2c6 100644--- a/app/views/imports/_import.html.erb+++ b/app/views/imports/_import.html.erb@@ -17,6 +17,14 @@<span class="px-1 py text-xs rounded-full bg-red-500/5 text-red-500 border border-alpha-black-50"><%= t(".failed") %></span>+ <% elsif import.reverting? %>+ <span class="px-1 py text-xs rounded-full bg-orange-500/5 text-orange-500 border border-alpha-black-50">+ <%= t(".reverting") %>+ </span>+ <% elsif import.revert_failed? %>+ <span class="px-1 py text-xs rounded-full bg-red-500/5 text-red-500 border border-alpha-black-50">+ <%= t(".revert_failed") %>+ </span><% elsif import.complete? %><span class="px-1 py text-xs rounded-full bg-green-500/5 text-green-500 border border-alpha-black-50"><%= t(".complete") %>@@ -33,7 +41,16 @@<span><%= t(".view") %></span><% end %>- <% unless import.complete? %>+ <% if import.complete? || import.revert_failed? %>+ <%= button_to revert_import_path(import),+ method: :put,+ class: "block w-full py-2 px-3 space-x-2 text-orange-600 hover:bg-orange-50 flex items-center rounded-lg",+ data: { turbo_confirm: true } do %>+ <%= lucide_icon "rotate-ccw", class: "w-5 h-5" %>++ <span>Revert</span>+ <% end %>+ <% else %><%= button_to import_path(import),method: :delete,class: "block w-full py-2 px-3 space-x-2 text-red-600 hover:bg-red-50 flex items-center rounded-lg",diff --git a/app/views/imports/_revert_failure.html.erb b/app/views/imports/_revert_failure.html.erbnew file mode 100644index 00000000..cfdb08c3--- /dev/null+++ b/app/views/imports/_revert_failure.html.erb@@ -0,0 +1,18 @@+<%# locals: (import:) %>++<div class="h-full flex flex-col justify-center items-center">+ <div class="space-y-6 max-w-sm">+ <div class="mx-auto bg-red-500/5 h-8 w-8 rounded-full flex items-center justify-center">+ <%= lucide_icon "alert-octagon", class: "w-5 h-5 text-red-500" %>+ </div>++ <div class="text-center space-y-2">+ <h1 class="font-medium text-gray-900 text-center text-3xl">Reverting import failed</h1>+ <p class="text-sm text-gray-500">Please try again or contact support.</p>+ </div>++ <div>+ <%= button_to "Try again", revert_import_path(import), class: "btn btn--primary text-center w-full" %>+ </div>+ </div>+</div>diff --git a/app/views/imports/show.html.erb b/app/views/imports/show.html.erbindex 163be644..ffa55297 100644--- a/app/views/imports/show.html.erb+++ b/app/views/imports/show.html.erb@@ -10,6 +10,8 @@<%= render "imports/success", import: @import %><% elsif @import.failed? %><%= render "imports/failure", import: @import %>+<% elsif @import.revert_failed? %>+ <%= render "imports/revert_failure", import: @import %><% else %><%= render "imports/ready", import: @import %><% end %>diff --git a/config/locales/views/imports/en.yml b/config/locales/views/imports/en.ymlindex 77bbf059..01fe473f 100644--- a/config/locales/views/imports/en.yml+++ b/config/locales/views/imports/en.yml@@ -63,6 +63,8 @@ en:failed: Failedin_progress: In progresslabel: "%{type}: %{datetime}"+ reverting: Reverting+ revert_failed: Revert faileduploading: Processing rowsview: Viewindex:diff --git a/config/routes.rb b/config/routes.rbindex 26fcc22a..dc04a771 100644--- a/config/routes.rb+++ b/config/routes.rb@@ -65,6 +65,7 @@ Rails.application.routes.draw doresources :imports, only: %i[index new show create destroy] dopost :publish, on: :member+ put :revert, on: :memberresource :upload, only: %i[show update], module: :importresource :configuration, only: %i[show update], module: :importdiff --git a/db/migrate/20250206003115_remove_import_status_enum.rb b/db/migrate/20250206003115_remove_import_status_enum.rbnew file mode 100644index 00000000..2ea0866d--- /dev/null+++ b/db/migrate/20250206003115_remove_import_status_enum.rb@@ -0,0 +1,21 @@+class RemoveImportStatusEnum < ActiveRecord::Migration[7.2]+ def up+ change_column_default :imports, :status, nil+ change_column :imports, :status, :string+ execute "DROP TYPE IF EXISTS import_status"+ end++ def down+ execute <<-SQL+ CREATE TYPE import_status AS ENUM (+ 'pending',+ 'importing',+ 'complete',+ 'failed'+ );+ SQL++ change_column :imports, :status, :import_status, using: 'status::import_status'+ change_column_default :imports, :status, 'pending'+ end+enddiff --git a/db/schema.rb b/db/schema.rbindex a7ec28bc..5d6a8e12 100644--- a/db/schema.rb+++ b/db/schema.rb@@ -18,7 +18,6 @@ ActiveRecord::Schema[7.2].define(version: 2025_02_06_204404) do# Custom types defined in this database.# Note that some types may not work with other database engines. Be careful if changing database.create_enum "account_status", ["ok", "syncing", "error"]- create_enum "import_status", ["pending", "importing", "complete", "failed"]create_table "account_balances", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|t.uuid "account_id", null: false@@ -391,7 +390,7 @@ ActiveRecord::Schema[7.2].define(version: 2025_02_06_204404) docreate_table "imports", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|t.jsonb "column_mappings"- t.enum "status", default: "pending", enum_type: "import_status"+ t.string "status"t.string "raw_file_str"t.string "normalized_csv_str"t.datetime "created_at", null: falsediff --git a/test/fixtures/imports.yml b/test/fixtures/imports.ymlindex 00c09eff..97e2cd72 100644--- a/test/fixtures/imports.yml+++ b/test/fixtures/imports.yml@@ -1,3 +1,4 @@transaction:family: dylan_familytype: TransactionImport+ status: pendingdiff --git a/test/jobs/revert_import_job_test.rb b/test/jobs/revert_import_job_test.rbnew file mode 100644index 00000000..ca65d717--- /dev/null+++ b/test/jobs/revert_import_job_test.rb@@ -0,0 +1,7 @@+require "test_helper"++class RevertImportJobTest < ActiveJob::TestCase+ # test "the truth" do+ # assert true+ # end+end