planetscale_rails 0.1.4 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fac50d24f5d87d2be01f128dd42f63b75023d7761d5516c92ac8ad92f776fae
-  data.tar.gz: 29a0fc6de3302ccd5b228c458facf7516147c2ca78b5f1717979bfbd6d8534d8
+  metadata.gz: e1c96f1384c6bcee4a33e81124384b80ce8cff99823b1d5fc77ad926967087a4
+  data.tar.gz: '0880e54628a3c0b22a98f1883dce8fd6ac4aee57315fffab014d07c9da66e014'
 SHA512:
-  metadata.gz: 3993c4de9fb27abda2d3f9506f28a8f8c8b12312540fdee58d7838d37fb8af25fba31b2b7c291915e9f1488fc8586708f516e6149dede3fe26a4c22ce5e44cb9
-  data.tar.gz: 93bcfb6f5d2f2bc0096de75029a2c12de9db97ab1fa591aa50e37d8d1548c23142a2dbda0079d51b8078d160f3535ba8bed3965042331e7b447136d69abdd997
+  metadata.gz: c4fabd32053c4456bdd002729f21fd9548905a7fc8472a97dd23fb0f1aed9df5798381cae839fd4495b0acacdc97170c47b92312cc38c78a0a31df3911097765
+  data.tar.gz: 2f50ab3be8305f60c81c11d625f470775678bf311d103c1301d982fb1aa5f6c39ac8b176f21bd8eb4ea511098f22e8a77a3b09cdb459130ea60bdddcee37ae57

data/.rubocop.yml

@@ -1,6 +1,12 @@
 AllCops:
   TargetRubyVersion: 3
 
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes
@@ -10,7 +16,13 @@ Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 
 Layout/LineLength:
-  Max: 180
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
 
 Metrics/BlockLength:
   Enabled: false

data/Gemfile.lock

@@ -1,74 +1,74 @@
 PATH
   remote: .
   specs:
-    planetscale_rails (0.1.1)
+    planetscale_rails (0.2.0)
       colorize (~> 0.8.1)
-      rails (~> 7.0)
+      rails (>= 6.0, < 8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actioncable (7.0.6)
+      actionpack (= 7.0.6)
+      activesupport (= 7.0.6)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionmailbox (7.0.6)
+      actionpack (= 7.0.6)
+      activejob (= 7.0.6)
+      activerecord (= 7.0.6)
+      activestorage (= 7.0.6)
+      activesupport (= 7.0.6)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      actionview (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionmailer (7.0.6)
+      actionpack (= 7.0.6)
+      actionview (= 7.0.6)
+      activejob (= 7.0.6)
+      activesupport (= 7.0.6)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (7.0.4.2)
-      actionview (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
-      rack (~> 2.0, >= 2.2.0)
+    actionpack (7.0.6)
+      actionview (= 7.0.6)
+      activesupport (= 7.0.6)
+      rack (~> 2.0, >= 2.2.4)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actiontext (7.0.6)
+      actionpack (= 7.0.6)
+      activerecord (= 7.0.6)
+      activestorage (= 7.0.6)
+      activesupport (= 7.0.6)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.4.2)
-      activesupport (= 7.0.4.2)
+    actionview (7.0.6)
+      activesupport (= 7.0.6)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.4.2)
-      activesupport (= 7.0.4.2)
+    activejob (7.0.6)
+      activesupport (= 7.0.6)
       globalid (>= 0.3.6)
-    activemodel (7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activerecord (7.0.4.2)
-      activemodel (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activestorage (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    activemodel (7.0.6)
+      activesupport (= 7.0.6)
+    activerecord (7.0.6)
+      activemodel (= 7.0.6)
+      activesupport (= 7.0.6)
+    activestorage (7.0.6)
+      actionpack (= 7.0.6)
+      activejob (= 7.0.6)
+      activerecord (= 7.0.6)
+      activesupport (= 7.0.6)
       marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (7.0.4.2)
+    activesupport (7.0.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -83,12 +83,12 @@ GEM
     erubi (1.12.0)
     globalid (1.1.0)
       activesupport (>= 5.0)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
-    loofah (2.19.1)
+    loofah (2.21.3)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
+      nokogiri (>= 1.12.0)
     mail (2.8.1)
       mini_mime (>= 0.1.1)
       net-imap
@@ -97,8 +97,8 @@ GEM
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    minitest (5.18.0)
-    net-imap (0.3.4)
+    minitest (5.19.0)
+    net-imap (0.3.7)
       date
       net-protocol
     net-pop (0.1.2)
@@ -107,40 +107,42 @@ GEM
       timeout
     net-smtp (0.3.3)
       net-protocol
-    nio4r (2.5.8)
-    nokogiri (1.14.2-x86_64-darwin)
+    nio4r (2.5.9)
+    nokogiri (1.15.4-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.14.2-x86_64-linux)
+    nokogiri (1.15.4-x86_64-linux)
       racc (~> 1.4)
     parallel (1.22.1)
     parser (3.2.1.0)
       ast (~> 2.4.1)
-    racc (1.6.2)
-    rack (2.2.6.3)
-    rack-test (2.0.2)
+    racc (1.7.3)
+    rack (2.2.7)
+    rack-test (2.1.0)
       rack (>= 1.3)
-    rails (7.0.4.2)
-      actioncable (= 7.0.4.2)
-      actionmailbox (= 7.0.4.2)
-      actionmailer (= 7.0.4.2)
-      actionpack (= 7.0.4.2)
-      actiontext (= 7.0.4.2)
-      actionview (= 7.0.4.2)
-      activejob (= 7.0.4.2)
-      activemodel (= 7.0.4.2)
-      activerecord (= 7.0.4.2)
-      activestorage (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    rails (7.0.6)
+      actioncable (= 7.0.6)
+      actionmailbox (= 7.0.6)
+      actionmailer (= 7.0.6)
+      actionpack (= 7.0.6)
+      actiontext (= 7.0.6)
+      actionview (= 7.0.6)
+      activejob (= 7.0.6)
+      activemodel (= 7.0.6)
+      activerecord (= 7.0.6)
+      activestorage (= 7.0.6)
+      activesupport (= 7.0.6)
       bundler (>= 1.15.0)
-      railties (= 7.0.4.2)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+      railties (= 7.0.6)
+    rails-dom-testing (2.1.1)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.5.0)
-      loofah (~> 2.19, >= 2.19.1)
-    railties (7.0.4.2)
-      actionpack (= 7.0.4.2)
-      activesupport (= 7.0.4.2)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.6)
+      actionpack (= 7.0.6)
+      activesupport (= 7.0.6)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
@@ -175,15 +177,15 @@ GEM
     rubocop-ast (1.27.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.12.0)
-    thor (1.2.1)
-    timeout (0.3.2)
+    thor (1.2.2)
+    timeout (0.4.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
-    websocket-driver (0.7.5)
+    websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.6.7)
+    zeitwerk (2.6.9)
 
 PLATFORMS
   x86_64-darwin-20

data/README.md

@@ -15,7 +15,6 @@ against it. See [usage](#usage) for details.
 rake psdb:migrate                    # Migrate the database for current environment
 rake psdb:rollback                   # Rollback primary database for current environment
 rake psdb:schema:load                # Load the current schema into the database
-rake psdb:setup_pscale               # Setup a proxy to connect to PlanetScale
 ```
 
 ## Installation
@@ -34,36 +33,19 @@ And then execute in your terminal:
 bundle install
 ```
 
-### Update database.yml
-
-In your application's `database.yml`, you'll need to make two changes. This will allow the app to run migrations via a connection setup by the pscale CLI.
-
-1. Swap to port 3305 if `ENV['ENABLE_PSDB']` is true.
-2. Use production database name if `ENV['ENABLE_PSDB']` is true.
-
-Here is an example
-
-```
-development:
-  <<: *default
-  database: <%= ENV['ENABLE_PSDB'] ? 'your_production_db_name' : 'your_development_db_name' %>
-  port: <%= ENV['ENABLE_PSDB'] ? 3305 : ENV.fetch("DB_PORT", 3306) %>
-```
+Make sure you have the [`pscale` CLI installed](https://github.com/planetscale/cli#installation).
 
 ## Usage
 
-First, make sure you have the [`pscale` CLI installed](https://github.com/planetscale/cli#installation). You'll use `pscale` to create a new branch.
-
-1. Run this locally, it will create a new branch off of `main`. The `switch` command will update a `.pscale.yml` file to track 
-that this is the branch you want to migrate.
+1. Using pscale, create a new branch. This command will create a local `.pscale.yml` file. You should add it to your `.gitignore`.
 
 ```
-pscale branch switch my-new-branch-name --database my-db-name --create
+pscale branch switch my-new-branch-name --database my-db-name --create --wait
 ```
 
 **Tip:** In your database settings. Enable "Automatically copy migration data." Select "Rails" as the migration framework. This will auto copy your `schema_migrations` table between branches.
 
-2. Once your branch is ready, you can then use the `psdb` rake task to connect to your branch and run `db:migrate`.
+2. Run your schema migrations against the branch.
 
 ```
 bundle exec rails psdb:migrate
@@ -75,8 +57,6 @@ If you run multiple databases in your Rails app, you can specify the DB name.
 bundle exec rails psdb:migrate:primary
 ```
 
-This will connect to the branch that you created, and run migrations against the branch.
-
 If you make a mistake, you can use `bundle exec rails psdb:rollback` to rollback the changes on your PlanetScale branch.
 
 3. Next, you can either open the Deploy Request via the UI. Or the CLI.
@@ -88,6 +68,16 @@ pscale deploy-request create database-name my-new-branch-name
 
 4. To get your schema change to production, run the deploy request. Then, once it's complete, you can merge your code changes into your `main` branch in git and deploy your application code.
 
+## Using PlanetScale deploy requests vs `psdb:migrate` directly in production.
+
+PlanetScale's deploy requests [solve the schema change problem](https://planetscale.com/docs/learn/how-online-schema-change-tools-work). They make a normally high risk operation, safe. This is done by running your schema change using [Vitess's online schema change](https://vitess.io/docs/18.0/user-guides/schema-changes/) tools. Once the change is made, a deploy request is [also revertible without data loss](https://planetscale.com/blog/revert-a-migration-without-losing-data). None of this is possible when running `rails db:migrate` directly against your production database.
+
+We recommend using GitHub Actions to automate the creation of PlanetScale branches and deploy requests. Then when you are ready to merge, you can run the deploy request before merging in your code.
+
+**When not to use deploy requests**
+
+If your application has minimal data and schema changes are a low risk event, then running `psdb:migrate` directly against production is perfectly fine. As your datasize grows and your application becomes busier, the risk of schema changes increase and we highly recommend using the deploy request flow. It's the best way available to safely migrate your schema.
+
 ## Usage with GitHub Actions
 
 See the [GitHub Actions examples](actions-example.md) doc for ways to automate your schema migrations with PlanetScale + Actions.

data/actions-example.md

@@ -18,7 +18,7 @@ Secrets needed to be set:
 - `PLANETSCALE_SERVICE_TOKEN_ID`
 - `PLANETSCALE_SERVICE_TOKEN`
 
-The PlanetScale service token must have permission on the database to create/read development branches, as well as create deploy requests.
+The PlanetScale service token must have the `connect_branch`, `create_branch`, `delete_branch_password`, `read_branch`, `create_deploy_request`, and `read_deploy_request` permissions on the database.
 
 ```yaml
 name: Run database migrations

data/lib/planetscale_rails/tasks/psdb.rake

@@ -7,18 +7,13 @@ require "colorize"
 
 databases = ActiveRecord::Tasks::DatabaseTasks.setup_initial_database_yaml
 
-def shared_deps(name = nil)
-  return [:environment, :check_ci, "setup_pscale:#{name}".to_sym] if name
-  return %i[environment check_ci] if name.nil?
-end
-
 def puts_deploy_request_instructions
   ps_config = YAML.load_file(".pscale.yml")
   database = ps_config["database"]
   branch = ps_config["branch"]
   org = ps_config["org"]
 
-  puts "Create a deploy request for '#{branch}' by running:\n"
+  puts "Create a deploy request for '#{branch.colorize(:blue)}' by running:\n"
   puts "     pscale deploy-request create #{database} #{branch} --org #{org}\n\n"
 end
 
@@ -26,6 +21,28 @@ def kill_pscale_process
   Process.kill("TERM", ENV["PSCALE_PID"].to_i) if ENV["PSCALE_PID"]
 end
 
+def delete_password
+  password_id = ENV["PSCALE_PASSWORD_ID"]
+  return unless password_id
+
+  ps_config = YAML.load_file(".pscale.yml")
+  database = ps_config["database"]
+  branch = ps_config["branch"]
+
+  command = "pscale password delete #{database} #{branch} #{password_id} #{ENV["SERVICE_TOKEN_CONFIG"]} --force"
+  output = `#{command}`
+
+  return if $CHILD_STATUS.success?
+
+  puts "Failed to cleanup credentials used for PlanetScale connection. Password ID: #{password_id}".colorize(:red)
+  puts "Command: #{command}"
+  puts "Output: #{output}"
+end
+
+def db_branch_colorized(database, branch)
+  "#{database.colorize(:blue)}/#{branch.colorize(:blue)}"
+end
+
 namespace :psdb do
   task check_ci: :environment do
     use_service_token = ENV["PSCALE_SERVICE_TOKEN"] && ENV["PSCALE_SERVICE_TOKEN_ID"]
@@ -38,91 +55,63 @@ namespace :psdb do
     end
   end
 
-  desc "Setup a proxy to connect to PlanetScale"
-  task "setup_pscale" => shared_deps do
-    ENV["ENABLE_PSDB"] = "1"
-    ENV["DISABLE_PS_GEM"] = "1"
+  def create_connection_string
     ps_config = YAML.load_file(".pscale.yml")
     database = ps_config["database"]
     branch = ps_config["branch"]
 
     raise "You must have `pscale` installed on your computer".colorize(:red) unless command?("pscale")
     if branch.blank? || database.blank?
-      raise "Your branch is not properly setup, please switch to a branch by using the CLI.".colorize(:red)
-    end
-
-    r, = PTY.open
-
-    puts "Connecting to PlanetScale..."
-
-    # Spawns the process in the background
-    pid = Process.spawn("pscale connect #{database} #{branch} --port 3305 #{ENV["SERVICE_TOKEN_CONFIG"]}", out: r)
-    ENV["PSCALE_PID"] = pid.to_s
-
-    out = ""
-    start_time = Time.current
-    time_elapsed = Time.current - start_time
-    sleep(1)
-    while out.blank? && time_elapsed < 10.seconds
-      PTY.check(pid, true)
-      out = r.gets
-      time_elapsed = Time.current - start_time
+      raise "Could not determine which PlanetScale branch to use from .pscale.yml. Please switch to a branch by using: `pscale branch switch branch-name --database db-name --create --wait`".colorize(:red)
     end
 
-    raise "Timed out waiting for PlanetScale connection to be established".colorize(:red) if time_elapsed > 10.seconds
-  ensure
-    r&.close
-  end
+    short_hash = SecureRandom.hex(2)[0, 4]
+    password_name = "planetscale-rails-#{short_hash}"
+    command = "pscale password create #{database} #{branch} #{password_name} -f json #{ENV["SERVICE_TOKEN_CONFIG"]}"
 
-  namespace :setup_pscale do
-    ActiveRecord::Tasks::DatabaseTasks.for_each(databases) do |name|
-      desc "Setup a proxy to connect to #{name} in PlanetScale"
-      task name => shared_deps do
-        ENV["ENABLE_PSDB"] = "1"
-        ENV["DISABLE_PS_GEM"] = "1"
-        ps_config = YAML.load_file(".pscale.yml")
-        database = ps_config["database"]
-        branch = ps_config["branch"]
-
-        raise "You must have `pscale` installed on your computer" unless command?("pscale")
-        if branch.blank? || database.blank?
-          raise "Your branch is not properly setup, please switch to a branch by using the CLI."
-        end
+    output = `#{command}`
 
-        config = Rails.configuration.database_configuration[Rails.env][name]
+    if $CHILD_STATUS.success?
+      response = JSON.parse(output)
+      puts "Successfully created credentials for PlanetScale #{db_branch_colorized(database, branch)}"
+      host = response["access_host_url"]
+      username = response["username"]
+      password = response["plain_text"]
+      ENV["PSCALE_PASSWORD_ID"] = response["id"]
 
-        raise "Database #{name} is not configured for the current environment" unless config
+      adapter = "mysql2"
 
-        r, = PTY.open
-
-        puts "Connecting to PlanetScale..."
-
-        # Spawns the process in the background
-        pid = Process.spawn("pscale connect #{database} #{branch} --port 3305 #{ENV["SERVICE_TOKEN_CONFIG"]}", out: r)
-        ENV["PSCALE_PID"] = pid.to_s
+      if defined?(Trilogy)
+        adapter = "trilogy"
+      end
 
-        out = ""
-        start_time = Time.current
-        time_elapsed = Time.current - start_time
-        sleep(1)
-        while out.blank? && time_elapsed < 10.seconds
-          PTY.check(pid, true)
-          out = r.gets
-          time_elapsed = Time.current - start_time
-        end
+      # Setting schema_dump to nil is intentional. It prevents Rails from creating a dump after running migrations.
+      url = "#{adapter}://#{username}:#{password}@#{host}:3306/#{database}?ssl_mode=VERIFY_IDENTITY&schema_dump="
 
-        raise "Timed out waiting for PlanetScale connection to be established" if time_elapsed > 10.seconds
+      # Check common CA paths for certs.
+      ssl_ca_path = %w[/etc/ssl/certs/ca-certificates.crt /etc/pki/tls/certs/ca-bundle.crt /etc/ssl/ca-bundle.pem /etc/ssl/cert.pem].find { |f| File.exist?(f) }
 
-        # Comment out for now, this messes up when running migrations.
-        # Kernel.system("bundle exec rails db:environment:set RAILS_ENV=development")
-      ensure
-        r&.close
+      if ssl_ca_path
+        url += "&sslca=#{ssl_ca_path}"
       end
+
+      url
+    else
+      puts "Failed to create credentials for PlanetScale #{db_branch_colorized(database, branch)}"
+      puts "Command: #{command}"
+      puts "Output: #{output}"
+      puts "Please verify that you have the correct permissions to create a password for this branch."
+      exit 1
     end
   end
 
-  desc "Migrate the database for current environment"
-  task migrate: %i[environment check_ci setup_pscale] do
+  desc "Create credentials for PlanetScale and sets them to ENV['PSCALE_DATABASE_URL']"
+  task "create_creds" => %i[environment check_ci] do
+    ENV["PSCALE_DATABASE_URL"] = create_connection_string
+  end
+
+  desc "Connects to the current PlanetScale branch and runs rails db:migrate"
+  task migrate: %i[environment check_ci create_creds] do
     db_configs = ActiveRecord::Base.configurations.configs_for(env_name: ActiveRecord::Tasks::DatabaseTasks.env)
 
     unless db_configs.size == 1
@@ -130,41 +119,45 @@ namespace :psdb do
     end
 
     puts "Running migrations..."
-    Kernel.system("bundle exec rails db:migrate")
-    puts "Finished running migrations\n".colorize(:green)
-    puts_deploy_request_instructions
+
+    command = "DATABASE_URL=\"#{ENV["PSCALE_DATABASE_URL"]}\" bundle exec rails db:migrate"
+    IO.popen(command) do |io|
+      io.each_line do |line|
+        puts line
+      end
+    end
+
+    if $CHILD_STATUS.success?
+      puts_deploy_request_instructions
+    else
+      puts "Failed to run migrations".colorize(:red)
+    end
   ensure
-    kill_pscale_process
+    delete_password
   end
 
   namespace :migrate do
     ActiveRecord::Tasks::DatabaseTasks.for_each(databases) do |name|
-      desc "Migrate #{name} database for current environment"
-      task name => shared_deps(name) do
+      desc "Connects to the current PlanetScale branch and runs rails db:migrate:#{name}"
+      task name => %i[environment check_ci create_creds] do
         puts "Running migrations..."
-        # We run it using the Kernel.system here because this properly handles
-        # when exceptions occur whereas Rake::Task.invoke does not.
-        Kernel.system("bundle exec rake db:migrate:#{name}")
 
-        puts "Finished running migrations\n".colorize(:green)
-        puts_deploy_request_instructions
-      ensure
-        kill_pscale_process
-      end
-    end
-  end
+        name_env_key = "#{name.upcase}_DATABASE_URL"
+        command = "#{name_env_key}=\"#{ENV["PSCALE_DATABASE_URL"]}\" bundle exec rails db:migrate:#{name}"
 
-  namespace :truncate_all do
-    ActiveRecord::Tasks::DatabaseTasks.for_each(databases) do |name|
-      desc "Truncate all tables in #{name} database for current environment"
-      task name => shared_deps(name) do
-        puts "Truncating database..."
-        # We run it using the Kernel.system here because this properly handles
-        # when exceptions occur whereas Rake::Task.invoke does not.
-        Kernel.system("bundle exec rake db:truncate_all")
-        puts "Finished truncating database."
+        IO.popen(command) do |io|
+          io.each_line do |line|
+            puts line
+          end
+        end
+
+        if $CHILD_STATUS.success?
+          puts_deploy_request_instructions
+        else
+          puts "Failed to run migrations".colorize(:red)
+        end
       ensure
-        kill_pscale_process
+        delete_password
       end
     end
   end
@@ -172,31 +165,79 @@ namespace :psdb do
   namespace :schema do
     namespace :load do
       ActiveRecord::Tasks::DatabaseTasks.for_each(databases) do |name|
-        desc "Load the current schema into the #{name} database"
-        task name => shared_deps(name) do
+        desc "Connects to the current PlanetScale branch and runs rails db:schema:load:#{name}"
+        task name => %i[environment check_ci create_creds] do
           puts "Loading schema..."
-          # We run it using the Kernel.system here because this properly handles
-          # when exceptions occur whereas Rake::Task.invoke does not.
-          Kernel.system("bundle exec rake db:schema:load:#{name}")
-          puts "Finished loading schema."
+
+          name_env_key = "#{name.upcase}_DATABASE_URL"
+          command = "#{name_env_key}=\"#{ENV["PSCALE_DATABASE_URL"]}\" bundle exec rake db:schema:load:#{name}"
+
+          IO.popen(command) do |io|
+            io.each_line do |line|
+              puts line
+            end
+          end
+
+          unless $CHILD_STATUS.success?
+            puts "Failed to load schema".colorize(:red)
+          end
         ensure
-          kill_pscale_process
+          delete_password
         end
       end
     end
   end
 
+  desc "Connects to the current PlanetScale branch and runs rails db:rollback"
+  task rollback: %i[environment check_ci create_creds] do
+    db_configs = ActiveRecord::Base.configurations.configs_for(env_name: ActiveRecord::Tasks::DatabaseTasks.env)
+
+    unless db_configs.size == 1
+      raise "Found multiple database configurations, please specify which database you want to rollback using `psdb:rollback:<database_name>`".colorize(:red)
+    end
+
+    command = "DATABASE_URL=\"#{ENV["PSCALE_DATABASE_URL"]}\" bundle exec rails db:rollback"
+
+    IO.popen(command) do |io|
+      io.each_line do |line|
+        puts line
+      end
+    end
+
+    unless $CHILD_STATUS.success?
+      puts "Failed to rollback migrations".colorize(:red)
+    end
+  ensure
+    delete_password
+  end
+
   namespace :rollback do
     ActiveRecord::Tasks::DatabaseTasks.for_each(databases) do |name|
-      desc "Rollback #{name} database for current environment"
-      task name => shared_deps(name) do
+      desc "Connects to the current PlanetScale branch and runs rails db:rollback:#{name}"
+      task name => %i[environment check_ci create_creds] do
+        required_version = Gem::Version.new("6.1.0.0")
+        rails_version = Gem::Version.new(Rails.version)
+
+        if rails_version < required_version
+          raise "This version of Rails does not support rollback commands for multi-database Rails apps. Please upgrade to at least Rails 6.1"
+        end
+
         puts "Rolling back migrations..."
-        # We run it using the Kernel.system here because this properly handles
-        # when exceptions occur whereas Rake::Task.invoke does not.
-        Kernel.system("bundle exec rake db:rollback:#{name}")
-        puts "Finished rolling back migrations.".colorize(:green)
+
+        name_env_key = "#{name.upcase}_DATABASE_URL"
+        command = "#{name_env_key}=\"#{ENV["PSCALE_DATABASE_URL"]}\" bundle exec rake db:rollback:#{name}"
+
+        IO.popen(command) do |io|
+          io.each_line do |line|
+            puts line
+          end
+        end
+
+        unless $CHILD_STATUS.success?
+          puts "Failed to rollback migrations".colorize(:red)
+        end
       ensure
-        kill_pscale_process
+        delete_password
       end
     end
   end

data/lib/planetscale_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PlanetscaleRails
-  VERSION = "0.1.4"
+  VERSION = "0.2.1"
 end

data/planetscale_rails.gemspec

@@ -29,5 +29,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "colorize", "~> 0.8.1"
-  spec.add_dependency "rails", "~> 7.0"
+  spec.add_dependency "rails", ">= 6.0", "< 8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: planetscale_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.1
 platform: ruby
 authors:
 - Mike Coutermarsh
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-28 00:00:00.000000000 Z
+date: 2024-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -29,16 +29,22 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8'
 description: A collection of rake tasks to make managing schema migrations with PlanetScale
   easy
 email: