WIP: migrate stripe ids in DB

app/models/payment_gateway_object.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# A link between an object in the local database and another object in the remote payment gateway database
+class PaymentGatewayObject < ApplicationRecord
+  belongs_to :item, polymorphic: true
+  belongs_to :gateway_object, polymorphic: true
+end

app/models/payment_schedule.rb

@@ -67,10 +67,6 @@ class PaymentSchedule < PaymentDocument
     StripeService.create_stripe_subscription(self, setup_intent_id)
   end
 
-  def self.columns_out_of_footprint
-    %w[stp_subscription_id]
-  end
-
   private
 
   def generate_and_send_document

app/models/payment_schedule_item.rb

@@ -4,6 +4,8 @@
 class PaymentScheduleItem < Footprintable
   belongs_to :payment_schedule
   belongs_to :invoice
+  has_one :payment_gateway_object
+
   after_create :chain_record
 
   def first?
@@ -11,7 +13,7 @@ class PaymentScheduleItem < Footprintable
   end
 
   def payment_intent
-    return unless stp_invoice_id
+    return unless payment_gateway_object
 
     key = Setting.get('stripe_secret_key')
     stp_invoice = Stripe::Invoice.retrieve(stp_invoice_id, api_key: key)
@@ -19,6 +21,6 @@ class PaymentScheduleItem < Footprintable
   end
 
   def self.columns_out_of_footprint
-    %w[invoice_id stp_invoice_id state payment_method client_secret]
+    %w[invoice_id state payment_method client_secret]
   end
 end

db/migrate/20210416073410_create_payment_gateway_objects.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Saves references to remote objects, in the payment gateway database
+class CreatePaymentGatewayObjects < ActiveRecord::Migration[5.2]
+  def change
+    create_table :payment_gateway_objects do |t|
+      t.string :gateway_object_id
+      t.string :gateway_object_type
+      t.references :item, polymorphic: true
+    end
+  end
+end

db/migrate/20210416083610_migrate_stripe_ids_to_payment_gateway_objects.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require 'integrity/archive_helper'
+
+# From this migration we remove the deep association between Stripe and Fab-manager
+# and save the data related to the payment gateway in a generic way
+class MigrateStripeIdsToPaymentGatewayObjects < ActiveRecord::Migration[5.2]
+  def up
+    # first, check the footprints
+    Integrity::ArchiveHelper.check_footprints
+
+    # if everything is ok, proceed with migration
+    # remove and save periods in memory
+    periods = Integrity::ArchiveHelper.backup_and_remove_periods
+
+    ## INVOICES
+    puts 'Migrating invoices. This may take a while...'
+    Invoice.order(:id).all.each do |i|
+      if i.stp_invoice_id
+        PaymentGatewayObject.create!(
+          item: i,
+          gateway_object_id: i.stp_invoice_id,
+          gateway_object_type: 'Stripe::Invoice'
+        )
+      elsif i.stp_payment_intent_id
+        PaymentGatewayObject.create!(
+          item: i,
+          gateway_object_id: i.stp_payment_intent_id,
+          gateway_object_type: 'Stripe::PaymentIntent'
+        )
+      end
+    end
+    remove_column :invoices, :stp_invoice_id
+    remove_column :invoices, :stp_payment_intent_id
+
+    ## INVOICE ITEMS
+    puts 'Migrating invoices items. This may take a while...'
+    InvoiceItem.order(:id).all.each do |ii|
+      next unless ii.stp_invoice_item_id
+
+      PaymentGatewayObject.create!(
+        item: ii,
+        gateway_object_id: ii.stp_invoice_item_id,
+        gateway_object_type: 'Stripe::InvoiceItem'
+      )
+    end
+    remove_column :invoice_items, :stp_invoice_item_id
+
+    ## SUBSCRIPTIONS
+    # stp_subscription_id is not used anymore.
+    # It is an artifact of the very firsts releases of Fab-manager when we were creating a Stripe::Subscription for each new subscription.
+    # This was intended to automatically renew all subscriptions, but this feature was not acclaimed by the users.
+    # To fix it, we made a workaround to automatically cancel the subscription, just after it was took.
+    # This workaround was kept in the code until v4.1.0 (SCA release), when we removed this whole pointless feature.
+    # We keep this data for accounting integrity but we don't know it is gonna be useful again in the future
+    puts 'Migrating subscriptions. This may take a while...'
+    Subscription.order(:id).all.each do |sub|
+      next unless sub.stp_subscription_id
+
+      PaymentGatewayObject.create!(
+        item: sub,
+        gateway_object_id: sub.stp_subscription_id,
+        gateway_object_type: 'Stripe::Subscription'
+      )
+    end
+    remove_column :subscriptions, :stp_subscription_id
+
+    ## PAYMENT SCHEDULES
+    puts 'Migrating payment schedules. This may take a while...'
+    PaymentSchedule.order(:id).all.each do |ps|
+      if ps.stp_subscription_id
+        PaymentGatewayObject.create!(
+          item: ps,
+          gateway_object_id: ps.stp_subscription_id,
+          gateway_object_type: 'Stripe::Subscription'
+        )
+      end
+      next unless ps.stp_setup_intent_id
+
+      PaymentGatewayObject.create!(
+        item: ps,
+        gateway_object_id: ps.stp_setup_intent_id,
+        gateway_object_type: 'Stripe::SetupIntent'
+      )
+    end
+    remove_column :payment_schedules, :stp_subscription_id
+    remove_column :payment_schedules, :stp_setup_intent_id
+
+    ## PAYMENT SCHEDULE ITEMS
+    puts 'Migrating payment schedule items. This may take a while...'
+    PaymentScheduleItem.order(:id).all.each do |psi|
+      next unless psi.stp_invoice_id
+
+      PaymentGatewayObject.create!(
+        item: psi,
+        gateway_object_id: psi.stp_invoice_id,
+        gateway_object_type: 'Stripe::Invoice'
+      )
+    end
+    remove_column :payment_schedule_items, :stp_invoice_id
+
+    ## PLANS, MACHINES, SPACES, TRAININGS
+    puts 'Migration stp_product_ids. This may take a while...'
+    [Plan, Machine, Space, Training].each do |klass|
+      klass.order(:id).all.each do |item|
+        next unless item.stp_product_id
+
+        PaymentGatewayObject.create!(
+          item: item,
+          gateway_object_id: item.stp_product_id,
+          gateway_object_type: 'Stripe::Product'
+        )
+        remove_column klass.arel_table.name, :stp_product_id
+      end
+    end
+
+    # chain all records
+    InvoiceItem.order(:id).all.each(&:chain_record)
+    Invoice.order(:id).all.each(&:chain_record)
+    PaymentScheduleItem.order(:id).all.each(&:chain_record)
+    PaymentSchedule.order(:id).all.each(&:chain_record)
+
+    # re-create all archives from the memory dump
+    Integrity::ArchiveHelper.restore_periods(periods)
+  end
+
+  def down
+    # here we don't check footprints to save processing time and because this is pointless when reverting the migrations
+
+    # remove and save periods in memory
+    periods = Integrity::ArchiveHelper.backup_and_remove_periods
+
+    # reset parameters
+    add_column :invoices, :stp_invoice_id, :string
+    add_column :invoices, :stp_payment_intent_id, :string
+    add_column :invoice_items, :stp_invoice_item_id, :string
+    add_column :subscriptions, :stp_subscription_id, :string
+    add_column :payment_schedules, :stp_subscription_id, :string
+    add_column :payment_schedules, :stp_setup_intent_id, :string
+    add_column :payment_schedule_items, :stp_invoice_id, :string
+    [Plan, Machine, Space, Training].each do |klass|
+      add_column klass.arel_table.name, :stp_product_id, :string
+    end
+    PaymentGatewayObject.order(:id).all.each do |pgo|
+      attr = case pgo.gateway_object_type
+             when 'Stripe::Product'
+               'stp_product_id'
+             when 'Stripe::Invoice'
+               'stp_invoice_id'
+             when 'Stripe::SetupIntent'
+               'stp_setup_intent_id'
+             when 'Stripe::Subscription'
+               'stp_subscription_id'
+             when 'Stripe::InvoiceItem'
+               'stp_invoice_item_id'
+             when 'Stripe::PaymentIntent'
+               'stp_payment_intent_id'
+             else
+               raise "Unknown gateway_object_type #{pgo.gateway_object_type}"
+             end
+      item = pgo.item
+      item.update_column(attr, pgo.gateway_object_id)
+    end
+
+    # chain all records
+    InvoiceItem.order(:id).all.each(&:chain_record)
+    Invoice.order(:id).all.each(&:chain_record)
+    PaymentScheduleItem.order(:id).all.each(&:chain_record)
+    PaymentSchedule.order(:id).all.each(&:chain_record)
+
+    # re-create all archives from the memory dump
+    Integrity::ArchiveHelper.restore_periods(periods)
+  end
+end