canvas_sync 0.27.1.beta2 → 0.27.1.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50549b542e0425d35fc1effb9f505ce4a1d75e1517eb1e32b2a8bbffb00ee7de
-  data.tar.gz: 6442ed0b393e7e234984eb78dced6ef82aa388767ffba09f483de78b411e4ff5
+  metadata.gz: 569b75049c7212d44318075a8d2ff1680cbd0d7d68a5446a0b94ec09718eef95
+  data.tar.gz: 911fd5399e951f4badf0dd77baf78badb8e930606e6f031bbda67eee79e05e72
 SHA512:
-  metadata.gz: 7c5c55806050f7fb686d7331d39b611def2783c0f9db57c6437cea99df30d69038671b3fc9b7b1bc9e4c4065e4a1ce8eb164db92cf4a40399c823e2d1e0f28a7
-  data.tar.gz: f743ab5316387d8a0519e29d8675e2246ace7cefdb8d9acff9a5d2ed42e3cc0fce55287a2c779105f7b51502331aac3cb75bb900a38096247626b57274c92c47
+  metadata.gz: 1fc6af99ed8eb1e3f9c4b5be559beff9e390b9913c966641c5fa0ef4e77714494bc33b96b174d4c0b332bf1e288a566b9346569932e52760a7a501b520e65a57
+  data.tar.gz: b2ad6cbeb8b979ea843fab8ee161a4b7acc82b620fee99467284ff79e150e2625913c4797d057d76e253eb576e85c0c8e4368f9028a0660fcc2b80bfb29ec132

data/lib/canvas_sync/jobs/beta_cleanup/delete_temp_tables_job.rb

@@ -1,13 +1,12 @@
 module CanvasSync
   module Jobs::BetaCleanup
     class DeleteTempTablesJob < CanvasSync::Job
-
       def perform(options = {})
         tables = options[:models] || []
         return if tables.empty?
 
         tables.each do |table_name|
-          ActiveRecord::Base.connection.drop_table(table_name, if_exists: true)
+          ActiveRecord::Base.connection.drop_table("beta_#{table_name}", if_exists: true)
         end
       end
     end

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.27.1.beta2".freeze
+  VERSION = "0.27.1.beta3".freeze
 end

data/spec/canvas_sync/jobs/beta_cleanup/create_temp_tables_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+RSpec.describe CanvasSync::Jobs::BetaCleanup::CreateTempTablesJob do
+  describe "#perform" do
+    it "creates a beta_<table> for each model with the records with an updated_at after the updated_after param " do
+      MODELS_TO_SYNC = %w[accounts courses enrollments users]
+
+      MODELS_TO_SYNC.each do |table_name|
+        model = table_name.singularize.to_sym
+        FactoryBot.create_list(model, 3, updated_at: 4.weeks.ago)
+        FactoryBot.create_list(model, 2, updated_at: 1.week.ago)
+      end
+
+      described_class.new.perform({ models: MODELS_TO_SYNC, updated_after: 2.weeks.ago })
+      beta_tables = MODELS_TO_SYNC.map { |table_name| "beta_#{table_name}" }
+      expect(ActiveRecord::Base.connection.tables & beta_tables).to match_array(beta_tables)
+      expect(beta_tables.all? { |table_name| ActiveRecord::Base.connection.exec_query("SELECT COUNT(*) FROM #{table_name}").rows.flatten.first == 2 }).to be true
+      # original tables should no longer have the records that were moved to the beta tables
+      expect(MODELS_TO_SYNC.all? { |table_name| ActiveRecord::Base.connection.exec_query("SELECT COUNT(*) FROM #{table_name}").rows.flatten.first == 3 }).to be true
+    end
+  end
+end

data/spec/canvas_sync/jobs/beta_cleanup/delete_related_records_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+RSpec.describe CanvasSync::Jobs::BetaCleanup::DeleteRelatedRecordsJob do
+  describe "#perform" do
+    let(:models_to_sync) { %w[accounts] }
+    let(:conn) { ActiveRecord::Base.connection }
+
+    before(:each) do
+      @accounts = FactoryBot.create_list(:account, 3, updated_at: 1.week.ago)
+      @records_to_readd = @accounts[0..1]
+      CanvasSync::Jobs::BetaCleanup::CreateTempTablesJob.new.perform({ models: models_to_sync, updated_after: 2.weeks.ago })
+      # we pretend a sync happens, which re-adds 2/3 of the previous records
+      Account.create!(@records_to_readd.map(&:attributes))
+      # This means that records[2] should have its association deleted in any LTI specific tables via its foreign key
+    end
+
+    it "deletes records in associated tables via their foreign key" do
+      conn.exec_query(<<~SQL)
+        CREATE TABLE purchases (
+          id SERIAL PRIMARY KEY,
+          canvas_account_id INTEGER
+        )
+      SQL
+      conn.exec_query(<<~SQL)
+        INSERT INTO purchases (canvas_account_id) VALUES (#{@accounts[0].canvas_id}), (#{@accounts[1].canvas_id}), (#{@accounts[2].canvas_id});
+      SQL
+      # the record in this table with canvas_account_id = 3 should be deleted (records[2])
+      described_class.new.perform({ models: models_to_sync })
+      expect(conn.exec_query("SELECT canvas_account_id FROM purchases").rows.flatten).to match_array(@records_to_readd.map(&:canvas_id))
+    end
+
+    # BACKWARD COMPABILITY WITH THE ID COLUMN
+    # In newer versions of CanvasSync, tables no longer have the "id" primary key and only have the "canvas_id" column
+    # Older apps may still have tables with an "id" primary key
+    context "when the table has an 'id' column as a primary key instead of 'canvas_id'" do
+      it "deletes the records via the 'account_id' foreign key" do
+        conn.execute(<<~SQL)
+          ALTER TABLE accounts ADD COLUMN id SERIAL PRIMARY KEY;
+          ALTER TABLE beta_accounts ADD COLUMN id SERIAL PRIMARY KEY;
+        SQL
+        conn.exec_query(<<~SQL)
+          CREATE TABLE customers (
+            id SERIAL PRIMARY KEY,
+            account_id INTEGER
+          )
+        SQL
+        conn.exec_query(<<~SQL)
+          INSERT INTO customers (account_id) VALUES (1), (2), (3);
+        SQL
+        described_class.new.perform({ models: models_to_sync })
+        expect(conn.exec_query("SELECT account_id FROM customers").rows.flatten).to match_array([1, 2])
+      end
+    end
+  end
+
+end

data/spec/canvas_sync/jobs/beta_cleanup/delete_temp_tables_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe CanvasSync::Jobs::BetaCleanup::DeleteTempTablesJob do
+  describe '#perform' do
+    let(:conn) { ActiveRecord::Base.connection }
+    let(:models_to_sync) { %w[accounts courses]}
+
+    before do
+      CanvasSync::Jobs::BetaCleanup::CreateTempTablesJob.new.perform({ models: models_to_sync })
+    end
+
+    it 'deletes the specified tables' do
+      expect(models_to_sync.all? { |table_name| conn.data_source_exists?("beta_#{table_name}") }).to be true
+      described_class.new.perform({ models: models_to_sync })
+      expect(models_to_sync.all? { |table_name| conn.data_source_exists?("beta_#{table_name}") }).to be false
+      expect(models_to_sync.all? { |table_name| conn.data_source_exists?(table_name) }).to be true
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.27.1.beta2
+  version: 0.27.1.beta3
 platform: ruby
 authors:
 - Instructure CustomDev
@@ -570,6 +570,9 @@ files:
 - lib/canvas_sync/sidekiq_job.rb
 - lib/canvas_sync/version.rb
 - spec/canvas_sync/canvas_sync_spec.rb
+- spec/canvas_sync/jobs/beta_cleanup/create_temp_tables_spec.rb
+- spec/canvas_sync/jobs/beta_cleanup/delete_related_records_spec.rb
+- spec/canvas_sync/jobs/beta_cleanup/delete_temp_tables_spec.rb
 - spec/canvas_sync/jobs/canvas_process_waiter_spec.rb
 - spec/canvas_sync/jobs/job_spec.rb
 - spec/canvas_sync/jobs/report_starter_spec.rb
@@ -763,6 +766,9 @@ specification_version: 4
 summary: Gem for generating Canvas models and migrations and syncing data from Canvas
 test_files:
 - spec/canvas_sync/canvas_sync_spec.rb
+- spec/canvas_sync/jobs/beta_cleanup/create_temp_tables_spec.rb
+- spec/canvas_sync/jobs/beta_cleanup/delete_related_records_spec.rb
+- spec/canvas_sync/jobs/beta_cleanup/delete_temp_tables_spec.rb
 - spec/canvas_sync/jobs/canvas_process_waiter_spec.rb
 - spec/canvas_sync/jobs/job_spec.rb
 - spec/canvas_sync/jobs/report_starter_spec.rb