searchcraft 0.4.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 913320513d07b3447532e62d060b3ebc118dce10531d2f1d62587bdccc5c8c33
-  data.tar.gz: f8b7d111101ece94baeffd41d5d4f42350f47a9b7db0d96e589ee2297e4ae196
+  metadata.gz: dcdc1a8d1072f3a64089e24aa0c6682876a00e0f0e0300a3b1552f299a5d4208
+  data.tar.gz: a3ced335b1a4042c43936d39af7efc678b3b0f4bfb6e8959260c1ed11da3be66
 SHA512:
-  metadata.gz: baab9337ba89647bd3cf7819570d0de0ae32a066c07d33587ac33c157f8bd3014c20516c6a3d5a2bc77ed37fb9e53fa73eabacef8fbf784b240cc5046da036a0
-  data.tar.gz: 4daaa7dcd5d3312740a83eb8f08efb6f86bc20179a0081e092207f7788673e9bb6ecc0b88ca47beeb33278406f96d4775653b24ccd4255282e9fd8eba16ba3b1
+  metadata.gz: 387710b8e2980b3f84539feef53ceec31dac0180f28a3bf12f77cbd3e9932d5d1bd971b4994e0f70719684922e011c2d7cce67b38f59667e02a14a778edb3713
+  data.tar.gz: 484faca6fe838694569d563a3df6f5849cf555db4e17191ca3e3d0647dbd9fa09a05cb6fff0231f9dd40a2128c23b52a96ea0c2aef0bddf08e003d55da110d3f

data/lib/ext/scenic/adapters/postgres.rb

@@ -0,0 +1,27 @@
+# Features of Scenic not available in v1.7.0
+class Scenic::Adapters::Postgres
+  # True if supplied relation name is populated. Useful for checking the
+  # state of materialized views which may error if created `WITH NO DATA`
+  # and used before they are refreshed. True for all other relation types.
+  #
+  # @param name The name of the relation
+  #
+  # @raise [MaterializedViewsNotSupportedError] if the version of Postgres
+  #   in use does not support materialized views.
+  #
+  # @return [boolean]
+  def populated?(name)
+    raise_unless_materialized_views_supported
+
+    schemaless_name = name.split(".").last
+
+    sql = "SELECT relispopulated FROM pg_class WHERE relname = '#{schemaless_name}'"
+    relations = execute(sql)
+
+    if relations.count.positive?
+      relations.first["relispopulated"].in?(["t", true])
+    else
+      false
+    end
+  end
+end

data/lib/searchcraft/builder.rb

@@ -24,8 +24,20 @@ class SearchCraft::Builder
   end
 
   class << self
+    def with_no_data
+      @with_no_data = true
+    end
+
+    def with_data
+      @with_no_data = false
+    end
+
+    def with_no_data?
+      @with_no_data
+    end
+
     # Iterate through subclasses, and invoke recreate_view_if_changed!
-    def rebuild_any_if_changed!
+    def rebuild_any_if_changed!(skip_dump_schema: false)
       SearchCraft::ViewHashStore.setup_table_if_needed!
 
       sorted_builders = sort_builders_by_dependency
@@ -39,7 +51,10 @@ class SearchCraft::Builder
 
       builders_changed = []
       sorted_builders.each do |builder|
-        changed = builder.new.recreate_view_if_changed!(builders_changed: builders_changed)
+        changed = builder.new.recreate_view_if_changed!(
+          builders_changed: builders_changed,
+          skip_dump_schema: skip_dump_schema
+        )
         builders_changed << builder if changed
       end
 
@@ -98,7 +113,9 @@ class SearchCraft::Builder
   def view_sql
     # remove trailing ; from view_sql
     inner_sql = view_select_sql.gsub(/;\s*$/, "")
-    "CREATE MATERIALIZED VIEW #{view_name} AS (#{inner_sql}) WITH DATA;"
+
+    with_data = self.class.with_no_data? ? "WITH NO DATA" : "WITH DATA"
+    "CREATE MATERIALIZED VIEW #{view_name} AS (#{inner_sql}) #{with_data};"
   end
 
   # After materialized view created, do you need indexes on its columns?
@@ -114,7 +131,7 @@ class SearchCraft::Builder
 
   # If missing or changed, drop and create view
   # Returns false if no change required
-  def recreate_view_if_changed!(builders_changed: [])
+  def recreate_view_if_changed!(builders_changed: [], skip_dump_schema: false)
     if SearchCraft.debug?
       warn "#{self.class.name}#recreate_view_if_changed!"
       warn "  builders_changed: #{builders_changed.map(&:name).join(", ")}" if builders_changed.any?
@@ -139,12 +156,13 @@ class SearchCraft::Builder
     drop_view!
     create_view!
     update_hash_store!
-    dump_schema!
+    dump_schema! unless skip_dump_schema
 
     true
   end
 
   def create_view!
+    warn "Creating view/sequence/indexes for #{view_name}..." if SearchCraft.debug?
     create_sequence!
     sql_execute(view_sql)
     create_indexes!
@@ -152,13 +170,16 @@ class SearchCraft::Builder
 
   # Finds and drops all indexes and sequences on view, and then drops view
   def drop_view!
+    puts "Dropping view/sequence for #{view_name}..." if SearchCraft.debug?
     sql_execute("DROP MATERIALIZED VIEW IF EXISTS #{view_name} CASCADE;")
 
     sql_execute("DROP SEQUENCE IF EXISTS #{view_id_sequence_name};")
 
+    warn "Updating ViewHashStore for #{self.class.name}" if SearchCraft.debug?
     SearchCraft::ViewHashStore.reset!(builder: self)
   end
 
+  # TODO: what if indexes didn't change?
   def recreate_indexes!
     drop_indexes!
     create_indexes!

data/lib/searchcraft/model.rb

@@ -1,4 +1,5 @@
 require "scenic"
+require "ext/scenic/adapters/postgres"
 
 module SearchCraft::Model
   # Maintain a list of classes that include this module
@@ -21,13 +22,18 @@ module SearchCraft::Model
   # Runs .refresh! on all classes that include SearchCraft::Model
   def self.refresh_all!
     included_classes.each do |klass|
-      warn "Refreshing materialized view #{klass.table_name}..." unless Rails.env.test?
       if klass.is_a?(ClassMethods)
         klass.refresh!
       end
     end
   end
 
+  def self.refresh_any_unpopulated!
+    included_classes.each do |klass|
+      klass.refresh! unless klass.populated?
+    end
+  end
+
   def self.included_classes
     @included_classes | if SearchCraft.config.explicit_model_class_names
       SearchCraft.config.explicit_model_class_names.map(&:constantize)
@@ -38,12 +44,53 @@ module SearchCraft::Model
 
   module ClassMethods
     def refresh!
-      Scenic.database.refresh_materialized_view(table_name, concurrently: @refresh_concurrently, cascade: false)
+      refresh_concurrently = @refresh_concurrently && populated?
+      unless Rails.env.test?
+        if refresh_concurrently
+          warn "Refreshing materialized view concurrently #{table_name}..."
+        else
+          warn "Refreshing materialized view #{table_name}..."
+        end
+      end
+
+      Scenic.database.refresh_materialized_view(table_name, concurrently: refresh_concurrently, cascade: false)
+    rescue ActiveRecord::StatementInvalid
+      # If populated? lies and returns true; then might get error:
+      # PG::FeatureNotSupported: ERROR:  CONCURRENTLY cannot be used when the materialized view is not populated (ActiveRecord::StatementInvalid)
+      Scenic.database.refresh_materialized_view(table_name, concurrently: false, cascade: false)
+    end
+
+    def populated?
+      Scenic.database.populated?(table_name)
     end
 
     def refresh_concurrently=(value)
       @refresh_concurrently = value
     end
+
+    # Checks the database server to see if the materialized view is currently being refreshed
+    def currently_refreshing?
+      # quoted_table_name is table_name, but with double quotes around each chunk
+      # e.g. "schema"."table" or "table"
+      quoted_table_name = Scenic.database.quote_table_name(table_name)
+      dbname = ActiveRecord::Base.connection_db_config.database
+      sql = <<~SQL
+        SELECT EXISTS (
+          SELECT 1
+          FROM pg_stat_activity
+          WHERE datname = '#{dbname}'
+            AND query LIKE '%REFRESH MATERIALIZED VIEW #{quoted_table_name}%'
+            AND pid <> pg_backend_pid()
+        ) AS is_refresh_running;
+      SQL
+
+      warn "Checking if #{table_name} is currently being refreshed..." if SearchCraft.debug?
+      if (result = ActiveRecord::Base.connection.execute(sql))
+        result.first["is_refresh_running"]
+      else
+        false
+      end
+    end
   end
 
   def read_only?

data/lib/searchcraft/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SearchCraft
-  VERSION = "0.4.2"
+  VERSION = "0.5.1"
 end

data/lib/tasks/refresh.rake

@@ -5,7 +5,7 @@ namespace :searchcraft do
     require "benchmark"
     SearchCraft.config.explicit_model_class_names.each do |model_class_name|
       klass = model_class_name.constantize
-      puts "Refreshing materialized views for #{klass.name}"
+      warn "Refreshing materialized views for #{klass.name}"
       puts Benchmark.measure { klass.refresh! }
     end
   end

data/sig/ext/misc.rbs

@@ -10,6 +10,11 @@ module ActiveRecord
 
   class Base
     def self.configurations: () -> ActiveRecord::DatabaseConfigurations
+    def self.connection_db_config: () -> ActiveRecord::DatabaseConfig
+  end
+
+  class DatabaseConfig
+    def database: () -> String
   end
 end
 
@@ -26,6 +31,12 @@ module Scenic
   module Adapters
     class Postgres
       def refresh_materialized_view: (String, ?concurrently: bool, ?cascade: bool) -> nil
+      def populated?: (String) -> bool
+      def quote_table_name: (String) -> String
+
+      # The following are due to temporary ext/scenic/adapters/postgres.rb
+      def raise_unless_materialized_views_supported: () -> nil
+      def execute: (String) -> ActiveRecord::Result
     end
   end
 

data/sig/searchcraft/builder.rbs

@@ -12,11 +12,14 @@ module SearchCraft
     def self.find_subclasses_via_rails_eager_load_paths: (?known_subclass_names: Array[String]) -> Array[String]
 
     def self.rebuild_all!: () -> void
-
     def self.rebuild_any_if_changed!: () -> void
 
     def self.recreate_indexes!: () -> void
 
+    def self.with_no_data: () -> void
+    def self.with_data: () -> void
+    def self.with_no_data?: () -> bool
+
     def create_view!: () -> void
 
     def dependencies_ready?: () -> bool

data/sig/searchcraft/model.rbs

@@ -5,6 +5,8 @@ module SearchCraft
 
       def refresh_all!: () -> void
 
+      def currently_refreshing?: () -> bool
+
       def table_name: () -> String
 
       def table_name=: (String) -> void
@@ -12,6 +14,8 @@ module SearchCraft
       def name: () -> String
 
       def refresh!: () -> void
+
+      def populated?: () -> bool
     end
 
     extend ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchcraft
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.1
 platform: ruby
 authors:
 - Dr Nic Williams
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-06 00:00:00.000000000 Z
+date: 2024-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -168,6 +168,7 @@ files:
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
+- lib/ext/scenic/adapters/postgres.rb
 - lib/search_craft.rb
 - lib/searchcraft.rb
 - lib/searchcraft/annotate.rb
@@ -217,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: Instant search for Rails and ActiveRecord