activeadmin_batched_export 0.1.0 → 0.3.0

data/lib/activeadmin/batched_export/snapshot_page.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require "securerandom"
+require "activeadmin/batched_export/errors"
+require "activeadmin/batched_export/export_cursor"
+require "activeadmin/batched_export/keyset_page"
+require "activeadmin/batched_export/snapshot_row"
+
+module ActiveAdmin
+  module BatchedExport
+    class SnapshotPage
+      HEADER = "X-Batched-Export-Snapshot"
+      INSERT_SLICE = 500
+      Page = Struct.new(:records, :snapshot_token, :next_cursor, :first_page)
+
+      def self.fetch(collection, model:, field:, direction:, cursor:, snapshot_param:, limit:)
+        if snapshot_param.present?
+          resume(collection, model: model, field: field, direction: direction,
+            cursor: cursor, snapshot_param: snapshot_param, limit: limit)
+        elsif SnapshotRow.available? && cursor.nil?
+          freeze_first(collection, model: model, field: field, direction: direction, limit: limit)
+        else
+          live(collection, model: model, field: field, direction: direction, cursor: cursor, limit: limit)
+        end
+      end
+
+      def self.freeze_first(collection, model:, field:, direction:, limit:)
+        SnapshotRow.expire_stale!(ttl: BatchedExport.config.snapshot_ttl)
+        # Full id list in process memory on freeze. Stream into insert_all when that ceiling matters.
+        ids = KeysetPage.ordered(collection, model: model, field: field, direction: direction)
+          .pluck(model.primary_key)
+        return Page.new(records: [], snapshot_token: nil, next_cursor: nil, first_page: true) if ids.empty?
+
+        token = insert_ids(ids, model.name)
+        walk(collection, model: model, field: field, direction: direction,
+          token: token, after_position: 0, limit: limit, first_page: true)
+      end
+
+      def self.resume(collection, model:, field:, direction:, cursor:, snapshot_param:, limit:)
+        raise InvalidExportSnapshotError unless SnapshotRow.available?
+        raise InvalidExportSnapshotError if cursor.nil? || cursor.position.nil?
+
+        token = authentic_token(snapshot_param, model.name)
+        walk(collection, model: model, field: field, direction: direction,
+          token: token, after_position: cursor.position, limit: limit, first_page: false)
+      end
+
+      def self.live(collection, model:, field:, direction:, cursor:, limit:)
+        records = KeysetPage.records(
+          collection, model: model, field: field, direction: direction, cursor: cursor, limit: limit
+        )
+        Page.new(
+          records: records,
+          snapshot_token: nil,
+          next_cursor: KeysetPage.next_cursor(
+            records, field: field, direction: direction, primary_key: model.primary_key, limit: limit
+          ),
+          first_page: cursor.nil?
+        )
+      end
+
+      def self.insert_ids(ids, resource_type)
+        token = SecureRandom.urlsafe_base64(32)
+        created_at = Time.current
+        ids.each_slice(INSERT_SLICE).with_index do |slice, slice_index|
+          SnapshotRow.insert_all(slice.each_with_index.map { |record_id, offset|
+            {
+              token: token, resource_type: resource_type, record_id: record_id,
+              position: (slice_index * INSERT_SLICE) + offset + 1, created_at: created_at
+            }
+          })
+        end
+        token
+      end
+
+      def self.authentic_token(raw, resource_type)
+        anchor = SnapshotRow.where(token: raw).order(:position).first
+        raise InvalidExportSnapshotError if anchor.nil?
+        raise InvalidExportSnapshotError if SnapshotRow.expired?(anchor.created_at, ttl: BatchedExport.config.snapshot_ttl)
+        raise InvalidExportSnapshotError unless anchor.resource_type == resource_type
+
+        anchor.token
+      end
+
+      def self.walk(collection, model:, field:, direction:, token:, after_position:, limit:, first_page:)
+        records, consumed = fill_live(collection, model: model, token: token,
+          after_position: after_position, limit: limit)
+        if SnapshotRow.remaining_after?(token, consumed) && records.length == limit
+          return Page.new(
+            records: records, snapshot_token: token, first_page: first_page,
+            next_cursor: KeysetPage.next_cursor(
+              records, field: field, direction: direction,
+              primary_key: model.primary_key, limit: limit, position: consumed
+            )
+          )
+        end
+
+        SnapshotRow.delete_token!(token)
+        Page.new(records: records, snapshot_token: nil, next_cursor: nil, first_page: first_page)
+      end
+
+      def self.fill_live(collection, model:, token:, after_position:, limit:)
+        live = []
+        consumed = after_position
+        position = after_position
+        loop do
+          window = SnapshotRow.window_after(token, position, limit)
+          break if window.empty?
+
+          found = live_by_id(collection, model.primary_key, window)
+          consumed = append_live(window, found, live, limit)
+          break if live.length == limit
+
+          position = window.last.position
+        end
+        [live, consumed]
+      end
+
+      def self.live_by_id(collection, primary_key, rows)
+        collection.where(primary_key => rows.map(&:record_id))
+          .index_by { |record| record.public_send(primary_key).to_i }
+      end
+
+      def self.append_live(window, found, live, limit)
+        consumed = nil
+        window.each do |row|
+          consumed = row.position
+          record = found[row.record_id.to_i]
+          next unless record
+
+          live << record
+          break if live.length == limit
+        end
+        consumed
+      end
+      private_class_method :freeze_first, :resume, :live, :insert_ids, :authentic_token,
+        :walk, :fill_live, :live_by_id, :append_live
+    end
+  end
+end

data/lib/activeadmin/batched_export/snapshot_row.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "active_record"
+
+module ActiveAdmin
+  module BatchedExport
+    class SnapshotRow < ::ActiveRecord::Base
+      self.table_name = "active_admin_batched_export_snapshot_rows"
+      self.record_timestamps = false
+
+      def self.available?
+        table_exists?
+      end
+
+      def self.expire_stale!(ttl:)
+        # Global sweep on freeze start. Upgrade to a per-token job when volume matters.
+        where("created_at < ?", cutoff(ttl)).delete_all
+      end
+
+      def self.expired?(created_at, ttl:)
+        created_at < cutoff(ttl)
+      end
+
+      def self.cutoff(ttl)
+        ttl.respond_to?(:ago) ? ttl.ago : Time.current - ttl
+      end
+
+      def self.window_after(token, position, limit)
+        where(token: token).where("position > ?", position).order(:position).limit(limit).to_a
+      end
+
+      def self.remaining_after?(token, position)
+        where(token: token).where("position > ?", position).exists?
+      end
+
+      def self.delete_token!(token)
+        where(token: token).delete_all
+      end
+    end
+  end
+end

data/lib/activeadmin/batched_export/styles.rb

@@ -26,6 +26,7 @@ module ActiveAdmin
         actions: "flex flex-wrap gap-3",
         primary_button: "rounded bg-blue-600 px-4 py-2 text-sm font-medium text-white hover:bg-blue-700 disabled:opacity-50",
         secondary_button: "hidden rounded border border-gray-300 px-4 py-2 text-sm font-medium hover:bg-gray-50 disabled:opacity-50 dark:border-gray-600 dark:hover:bg-gray-800",
+        cancel_button: "rounded border border-gray-300 px-4 py-2 text-sm font-medium hover:bg-gray-50 disabled:opacity-50 dark:border-gray-600 dark:hover:bg-gray-800",
         back_link: "inline-flex items-center text-sm text-blue-600 hover:underline"
       }.freeze
 

data/lib/activeadmin/batched_export/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveAdmin
   module BatchedExport
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activeadmin_batched_export
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrei Makarov
@@ -301,14 +301,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 description: Replaces long-lived ActiveAdmin index downloads with a batched export
   workspace, customizable views, and export column macros.
 email:
@@ -326,6 +326,7 @@ files:
 - SECURITY.md
 - activeadmin_batched_export.gemspec
 - app/assets/controllers/activeadmin_batched_export/batched_export_controller.js
+- app/assets/javascripts/activeadmin_batched_export/chunk_assembly.mjs
 - app/views/active_admin/batched_export/_actions.html.erb
 - app/views/active_admin/batched_export/_columns.html.erb
 - app/views/active_admin/batched_export/_filters.html.erb
@@ -336,13 +337,20 @@ files:
 - config/locales/activeadmin_batched_export.en.yml
 - config/polyrun_coverage.yml
 - lib/activeadmin/batched_export.rb
+- lib/activeadmin/batched_export/chunk_renderer.rb
 - lib/activeadmin/batched_export/configuration.rb
 - lib/activeadmin/batched_export/controller_methods.rb
 - lib/activeadmin/batched_export/engine.rb
+- lib/activeadmin/batched_export/errors.rb
+- lib/activeadmin/batched_export/export_cursor.rb
 - lib/activeadmin/batched_export/export_macro_catalog.rb
 - lib/activeadmin/batched_export/export_macro_resolver.rb
 - lib/activeadmin/batched_export/install.rb
+- lib/activeadmin/batched_export/keyset_page.rb
 - lib/activeadmin/batched_export/resource_extension.rb
+- lib/activeadmin/batched_export/row_sanitizer.rb
+- lib/activeadmin/batched_export/snapshot_page.rb
+- lib/activeadmin/batched_export/snapshot_row.rb
 - lib/activeadmin/batched_export/styles.rb
 - lib/activeadmin/batched_export/version.rb
 - lib/activeadmin_batched_export.rb
@@ -364,14 +372,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Batched CSV, JSON, and XML export workspace for ActiveAdmin 4
 test_files: []