scenic 1.7.0 → 1.9.0

data/lib/scenic/statements.rb

@@ -9,9 +9,11 @@ module Scenic
     # @param sql_definition [String] The SQL query for the view schema. An error
     #   will be raised if `sql_definition` and `version` are both set,
     #   as they are mutually exclusive.
-    # @param materialized [Boolean, Hash] Set to true to create a materialized
-    #   view. Set to { no_data: true } to create materialized view without
-    #   loading data. Defaults to false.
+    # @param materialized [Boolean, Hash] Set to a truthy value to create a
+    #   materialized view. Hash
+    # @option materialized [Boolean] :no_data (false) Set to true to create
+    #   materialized view without running the associated query. You will need
+    #   to perform a non-concurrent refresh to populate with data.
     # @return The database response from executing the create statement.
     #
     # @example Create from `db/views/searches_v02.sql`
@@ -26,7 +28,7 @@ module Scenic
       if version.present? && sql_definition.present?
         raise(
           ArgumentError,
-          "sql_definition and version cannot both be set",
+          "sql_definition and version cannot both be set"
         )
       end
 
@@ -37,10 +39,12 @@ module Scenic
       sql_definition ||= definition(name, version)
 
       if materialized
+        options = materialized_options(materialized)
+
         Scenic.database.create_materialized_view(
           name,
           sql_definition,
-          no_data: no_data(materialized),
+          no_data: options[:no_data]
         )
       else
         Scenic.database.create_view(name, sql_definition)
@@ -80,36 +84,59 @@ module Scenic
     #   as they are mutually exclusive.
     # @param revert_to_version [Fixnum] The version number to rollback to on
     #   `rake db rollback`
-    # @param materialized [Boolean, Hash] True if updating a materialized view.
-    #   Set to { no_data: true } to update materialized view without loading
-    #   data. Defaults to false.
+    # @param materialized [Boolean, Hash] True or a Hash if updating a
+    #   materialized view.
+    # @option materialized [Boolean] :no_data (false) Set to true to update
+    #   a materialized view without loading data. You will need to perform a
+    #   refresh to populate with data. Cannot be combined with the :side_by_side
+    #   option.
+    # @option materialized [Boolean] :side_by_side (false) Set to true to update
+    #   update a materialized view using our side-by-side strategy, which will
+    #   limit the time the view is locked at the cost of increasing disk usage.
+    #   The view is initially updated with a temporary name and atomically
+    #   swapped once it is successfully created with data. Cannot be combined
+    #   with the :no_data option.
     # @return The database response from executing the create statement.
     #
     # @example
     #   update_view :engagement_reports, version: 3, revert_to_version: 2
-    #
+    #   update_view :comments, version: 2, revert_to_version: 1, materialized: { side_by_side: true }
     def update_view(name, version: nil, sql_definition: nil, revert_to_version: nil, materialized: false)
       if version.blank? && sql_definition.blank?
         raise(
           ArgumentError,
-          "sql_definition or version must be specified",
+          "sql_definition or version must be specified"
         )
       end
 
       if version.present? && sql_definition.present?
         raise(
           ArgumentError,
-          "sql_definition and version cannot both be set",
+          "sql_definition and version cannot both be set"
         )
       end
 
       sql_definition ||= definition(name, version)
 
       if materialized
+        options = materialized_options(materialized)
+
+        if options[:no_data] && options[:side_by_side]
+          raise(
+            ArgumentError,
+            "no_data and side_by_side options cannot be combined"
+          )
+        end
+
+        if options[:side_by_side] && !transaction_open?
+          raise "a transaction is required to perform a side-by-side update"
+        end
+
         Scenic.database.update_materialized_view(
           name,
           sql_definition,
-          no_data: no_data(materialized),
+          no_data: options[:no_data],
+          side_by_side: options[:side_by_side]
         )
       else
         Scenic.database.update_view(name, sql_definition)
@@ -152,11 +179,17 @@ module Scenic
       Scenic::Definition.new(name, version).to_sql
     end
 
-    def no_data(materialized)
-      if materialized.is_a?(Hash)
-        materialized.fetch(:no_data, false)
+    def materialized_options(materialized)
+      if materialized.is_a? Hash
+        {
+          no_data: materialized.fetch(:no_data, false),
+          side_by_side: materialized.fetch(:side_by_side, false)
+        }
       else
-        false
+        {
+          no_data: false,
+          side_by_side: false
+        }
       end
     end
   end

data/lib/scenic/version.rb

@@ -1,3 +1,3 @@
 module Scenic
-  VERSION = "1.7.0".freeze
+  VERSION = "1.9.0".freeze
 end

data/scenic.gemspec

@@ -3,31 +3,35 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "scenic/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "scenic"
-  spec.version       = Scenic::VERSION
-  spec.authors       = ["Derek Prior", "Caleb Hearth"]
-  spec.email         = ["derekprior@gmail.com", "caleb@calebhearth.com"]
-  spec.summary       = "Support for database views in Rails migrations"
-  spec.description   = <<-DESCRIPTION
+  spec.name = "scenic"
+  spec.version = Scenic::VERSION
+  spec.authors = ["Derek Prior", "Caleb Hearth"]
+  spec.email = ["derekprior@gmail.com", "caleb@calebhearth.com"]
+  spec.summary = "Support for database views in Rails migrations"
+  spec.description = <<-DESCRIPTION
     Adds methods to ActiveRecord::Migration to create and manage database views
     in Rails
   DESCRIPTION
-  spec.homepage      = "https://github.com/scenic-views/scenic"
-  spec.license       = "MIT"
+  spec.homepage = "https://github.com/scenic-views/scenic"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.files = `git ls-files -z`.split("\x0")
   spec.require_paths = ["lib"]
 
+  spec.metadata = {
+    "funding-uri" => "https://github.com/scenic-views/scenic"
+  }
+
   spec.add_development_dependency "bundler", ">= 1.5"
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", ">= 3.3"
-  spec.add_development_dependency "pg", "~> 0.19"
+  spec.add_development_dependency "pg"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "ammeter", ">= 1.1.3"
   spec.add_development_dependency "yard"
   spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "standard"
 
   spec.add_dependency "activerecord", ">= 4.0.0"
   spec.add_dependency "railties", ">= 4.0.0"

data/spec/acceptance/user_manages_views_spec.rb

@@ -45,6 +45,17 @@ describe "User manages views" do
     verify_result "Child.take.name", "Elliot"
     verify_schema_contains 'add_index "children"'
 
+    successfully "rails generate scenic:view child --materialized --side-by-side"
+    verify_identical_view_definitions "children_v02", "children_v03"
+
+    write_definition "children_v03", "SELECT 'Juniper'::text AS name"
+    successfully "rake db:migrate"
+
+    successfully "rake db:reset"
+    verify_result "Child.take.name", "Juniper"
+    verify_schema_contains 'add_index "children"'
+
+    successfully "rake db:rollback"
     successfully "rake db:rollback"
     successfully "rake db:rollback"
     successfully "rails destroy scenic:model child"

data/spec/dummy/Rakefile

@@ -1,13 +1,13 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require File.expand_path("../config/application", __FILE__)
 
 Rails.application.load_tasks
 
-unless Rake::Task.task_defined?('db:environment:set')
-  desc 'dummy task for rails versions where this task does not exist'
-  task 'db:environment:set' do
-    #no op
+unless Rake::Task.task_defined?("db:environment:set")
+  desc "dummy task for rails versions where this task does not exist"
+  task "db:environment:set" do
+    # no op
   end
 end

data/spec/dummy/bin/bundle

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-load Gem.bin_path('bundler', 'bundle')
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+load Gem.bin_path("bundler", "bundle")

data/spec/dummy/bin/rails

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
-require_relative '../config/boot'
-require 'rails/commands'
+APP_PATH = File.expand_path("../../config/application", __FILE__)
+require_relative "../config/boot"
+require "rails/commands"

data/spec/dummy/bin/rake

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-require_relative '../config/boot'
-require 'rake'
+require_relative "../config/boot"
+require "rake"
 Rake.application.run

data/spec/dummy/config/application.rb

@@ -11,5 +11,9 @@ module Dummy
     config.cache_classes = true
     config.eager_load = false
     config.active_support.deprecation = :stderr
+
+    if config.active_support.respond_to?(:to_time_preserves_timezone)
+      config.active_support.to_time_preserves_timezone = :zone
+    end
   end
 end

data/spec/dummy/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path("../config/environment", __FILE__)
 run Rails.application

data/spec/dummy/db/migrate/20220112154220_add_pg_stat_statements_extension.rb

@@ -1,5 +1,5 @@
 class AddPgStatStatementsExtension < ActiveRecord::Migration[6.1]
   def change
-    enable_extension 'pg_stat_statements'
+    enable_extension "pg_stat_statements"
   end
 end

data/spec/dummy/db/schema.rb

@@ -11,9 +11,7 @@
 # It's strongly recommended that you check this file into your version control system.
 
 ActiveRecord::Schema.define(version: 2022_01_12_154220) do
-
   # These are extensions that must be enabled in order to support this database
   enable_extension "pg_stat_statements"
   enable_extension "plpgsql"
-
 end

data/spec/generators/scenic/model/model_generator_spec.rb

@@ -6,7 +6,7 @@ module Scenic::Generators
     before do
       allow(ViewGenerator).to receive(:new)
         .and_return(
-          instance_double("Scenic::Generators::ViewGenerator").as_null_object,
+          instance_double("Scenic::Generators::ViewGenerator").as_null_object
         )
     end
 
@@ -32,5 +32,13 @@ module Scenic::Generators
       expect(model_definition).to contain("self.refresh")
       expect(model_definition).to have_correct_syntax
     end
+
+    it "adds a populated? method to materialized models" do
+      run_generator ["active_user", "--materialized"]
+      model_definition = file("app/models/active_user.rb")
+
+      expect(model_definition).to contain("self.populated?")
+      expect(model_definition).to have_correct_syntax
+    end
   end
 end

data/spec/generators/scenic/view/view_generator_spec.rb

@@ -31,19 +31,45 @@ describe Scenic::Generators::ViewGenerator, :generator do
 
       run_generator ["aired_episode", "--materialized"]
       migration = migration_file(
-        "db/migrate/update_aired_episodes_to_version_2.rb",
+        "db/migrate/update_aired_episodes_to_version_2.rb"
       )
       expect(migration).to contain "materialized: true"
     end
   end
 
+  it "sets the no_data option when updating a materialized view" do
+    with_view_definition("aired_episodes", 1, "hello") do
+      allow(Dir).to receive(:entries).and_return(["aired_episodes_v01.sql"])
+
+      run_generator ["aired_episode", "--materialized", "--no-data"]
+      migration = migration_file(
+        "db/migrate/update_aired_episodes_to_version_2.rb"
+      )
+      expect(migration).to contain "materialized: { no_data: true }"
+      expect(migration).not_to contain "side_by_side"
+    end
+  end
+
+  it "sets the side-by-side option when updating a materialized view" do
+    with_view_definition("aired_episodes", 1, "hello") do
+      allow(Dir).to receive(:entries).and_return(["aired_episodes_v01.sql"])
+
+      run_generator ["aired_episode", "--materialized", "--side-by-side"]
+      migration = migration_file(
+        "db/migrate/update_aired_episodes_to_version_2.rb"
+      )
+      expect(migration).to contain "materialized: { side_by_side: true }"
+      expect(migration).not_to contain "no_data"
+    end
+  end
+
   it "uses 'replace_view' instead of 'update_view' if replace flag is set" do
     with_view_definition("aired_episodes", 1, "hello") do
       allow(Dir).to receive(:entries).and_return(["aired_episodes_v01.sql"])
 
       run_generator ["aired_episode", "--replace"]
       migration = migration_file(
-        "db/migrate/update_aired_episodes_to_version_2.rb",
+        "db/migrate/update_aired_episodes_to_version_2.rb"
       )
       expect(migration).to contain "replace_view"
     end

data/spec/integration/revert_spec.rb

@@ -61,7 +61,7 @@ describe "Reverting scenic schema statements", :db do
   end
 
   def run_migration(migration, directions)
-    silence_stream(STDOUT) do
+    silence_stream($stdout) do
       Array.wrap(directions).each do |direction|
         migration.migrate(direction)
       end

data/spec/scenic/adapters/postgres/connection_spec.rb

@@ -9,7 +9,7 @@ module Scenic
             base_response = double("response from base connection")
             base_connection = double(
               "Connection",
-              supports_materialized_views?: base_response,
+              supports_materialized_views?: base_response
             )
 
             connection = Postgres::Connection.new(base_connection)

data/spec/scenic/adapters/postgres/index_creation_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+module Scenic
+  module Adapters
+    describe Postgres::IndexCreation, :db do
+      it "successfully recreates applicable indexes" do
+        create_materialized_view("hi", "SELECT 'hi' AS greeting")
+        speaker = DummySpeaker.new
+
+        index = Scenic::Index.new(
+          object_name: "hi",
+          index_name: "hi_greeting_idx",
+          definition: "CREATE INDEX hi_greeting_idx ON hi (greeting)"
+        )
+
+        Postgres::IndexCreation
+          .new(connection: ActiveRecord::Base.connection, speaker: speaker)
+          .try_create([index])
+
+        expect(indexes_for("hi")).not_to be_empty
+        expect(speaker.messages).to include(/index 'hi_greeting_idx' .* has been created/)
+      end
+
+      it "skips indexes that are not applicable" do
+        create_materialized_view("hi", "SELECT 'hi' AS greeting")
+        speaker = DummySpeaker.new
+        index = Scenic::Index.new(
+          object_name: "hi",
+          index_name: "hi_person_idx",
+          definition: "CREATE INDEX hi_person_idx ON hi (person)"
+        )
+
+        Postgres::IndexCreation
+          .new(connection: ActiveRecord::Base.connection, speaker: speaker)
+          .try_create([index])
+
+        expect(indexes_for("hi")).to be_empty
+        expect(speaker.messages).to include(/index 'hi_person_idx' .* has been dropped/)
+      end
+    end
+
+    class DummySpeaker
+      attr_reader :messages
+
+      def initialize
+        @messages = []
+      end
+
+      def say(message, bool = false)
+        @messages << message
+      end
+    end
+  end
+end

data/spec/scenic/adapters/postgres/index_migration_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+module Scenic
+  module Adapters
+    describe Postgres::IndexMigration, :db, :silence do
+      it "moves indexes from the old view to the new view" do
+        create_materialized_view("hi", "SELECT 'hi' AS greeting")
+        create_materialized_view("hi_temp", "SELECT 'hi' AS greeting")
+        add_index(:hi, :greeting, name: "hi_greeting_idx")
+
+        Postgres::IndexMigration
+          .new(connection: ActiveRecord::Base.connection)
+          .migrate(from: "hi", to: "hi_temp")
+        indexes_for_original = indexes_for("hi")
+        indexes_for_temporary = indexes_for("hi_temp")
+
+        expect(indexes_for_original.length).to eq 1
+        expect(indexes_for_original.first.index_name).not_to eq "hi_greeting_idx"
+        expect(indexes_for_temporary.length).to eq 1
+        expect(indexes_for_temporary.first.index_name).to eq "hi_greeting_idx"
+      end
+    end
+  end
+end

data/spec/scenic/adapters/postgres/refresh_dependencies_spec.rb

@@ -9,27 +9,27 @@ module Scenic
         before do
           adapter.create_materialized_view(
             "first",
-            "SELECT text 'hi' AS greeting",
+            "SELECT text 'hi' AS greeting"
           )
           adapter.create_materialized_view(
             "second",
-            "SELECT * FROM first",
+            "SELECT * FROM first"
           )
           adapter.create_materialized_view(
             "third",
-            "SELECT * FROM first UNION SELECT * FROM second",
+            "SELECT * FROM first UNION SELECT * FROM second"
           )
           adapter.create_materialized_view(
             "fourth_1",
-            "SELECT * FROM third",
+            "SELECT * FROM third"
           )
           adapter.create_materialized_view(
             "x_fourth",
-            "SELECT * FROM fourth_1",
+            "SELECT * FROM fourth_1"
           )
           adapter.create_materialized_view(
             "fourth",
-            "SELECT * FROM fourth_1 UNION SELECT * FROM x_fourth",
+            "SELECT * FROM fourth_1 UNION SELECT * FROM x_fourth"
           )
 
           expect(adapter).to receive(:refresh_materialized_view)
@@ -49,7 +49,7 @@ module Scenic
             :fourth,
             adapter,
             ActiveRecord::Base.connection,
-            concurrently: true,
+            concurrently: true
           )
         end
 
@@ -58,7 +58,7 @@ module Scenic
             "public.fourth",
             adapter,
             ActiveRecord::Base.connection,
-            concurrently: true,
+            concurrently: true
           )
         end
       end
@@ -69,7 +69,7 @@ module Scenic
 
           adapter.create_materialized_view(
             "first",
-            "SELECT text 'hi' AS greeting",
+            "SELECT text 'hi' AS greeting"
           )
 
           expect {

data/spec/scenic/adapters/postgres/side_by_side_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+module Scenic
+  module Adapters
+    describe Postgres::SideBySide, :db, :silence do
+      it "updates the materialized view to the new version" do
+        adapter = Postgres.new
+        create_materialized_view("hi", "SELECT 'hi' AS greeting")
+        add_index(:hi, :greeting, name: "hi_greeting_idx")
+        new_definition = "SELECT 'hola' AS greeting"
+
+        Postgres::SideBySide
+          .new(adapter: adapter, name: "hi", definition: new_definition)
+          .update
+        result = ar_connection.execute("SELECT * FROM hi").first["greeting"]
+        indexes = indexes_for("hi")
+
+        expect(result).to eq "hola"
+        expect(indexes.length).to eq 1
+        expect(indexes.first.index_name).to eq "hi_greeting_idx"
+      end
+    end
+  end
+end

data/spec/scenic/adapters/postgres/temporary_name_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+module Scenic
+  module Adapters
+    describe Postgres::TemporaryName do
+      it "generates a temporary name based on a SHA1 hash of the original" do
+        name = "my_materialized_view"
+
+        temporary_name = Postgres::TemporaryName.new(name).to_s
+
+        expect(temporary_name).to match(/_scenic_sbs_[0-9a-f]{40}/)
+      end
+
+      it "does not overflow the 63 character limit for object names" do
+        name = "long_view_name_" * 10
+
+        temporary_name = Postgres::TemporaryName.new(name).to_s
+
+        expect(temporary_name.length).to eq 52
+      end
+    end
+  end
+end