planetscale_rails 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f38096cc4396fecb1efbfba9ea4bfe7f72b39c915990fb7036f8ab4ef1a1aaa2
-  data.tar.gz: c609fbd59e9caf5682fddd1367533c3a99a80fe1bbd7c93591da6047f8ff22cf
+  metadata.gz: 73da9fbd9cc5287b3a3088298413ff860891d8020ee1357fa4c0940ec113c6e2
+  data.tar.gz: f954e8a28f986965d20219cf631bc95030c6277f2652ade883f378c9bde26194
 SHA512:
-  metadata.gz: b4e11cfda4e78884bd30fe672b06517320f74a36244d96c61688d5d339478c99cff30050e31f049578fa27e5358692697b9019d0032108223d4c6dbb2e9a7c97
-  data.tar.gz: d236ee3a8a70d8e37be836e344c8e1a565c99149d7f301760810c8efc03ebea30e1cdb1e78458fc788b9fd9f41b1fe98fdaa4f9fc9e29cad1fb64636bf6d579f
+  metadata.gz: f964ab82aa2ce073f464d7d9e353714cae00a37f20a134a95a1650a7f9b78f69441297b639c702ddd48b2163ca363307d552567297536631263aae87c5b17e9e
+  data.tar.gz: 43537d76a32c25583c46d607e06b24b3f84ceb099e2083b13bbed6409bf43c0a74eb082b2682c32ff63748d45fbd8193d6517510338867dc05909753a603f274

data/.rubocop.yml

@@ -12,6 +12,12 @@ Style/StringLiteralsInInterpolation:
 Layout/LineLength:
   Max: 180
 
+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,40 @@ GEM
       timeout
     net-smtp (0.3.3)
       net-protocol
-    nio4r (2.5.8)
-    nokogiri (1.14.2-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.14.2-x86_64-linux)
+    nio4r (2.5.9)
+    nokogiri (1.15.3-x86_64-darwin)
       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.1)
+    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 +175,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
@@ -42,12 +41,13 @@ First, make sure you have the [`pscale` CLI installed](https://github.com/planet
 that this is the branch you want to migrate.
 
 ```
-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/Phoenix" as the migration framework. This will auto copy your `schema_migrations` table between branches.
+**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. Once your branch is ready, you can then use the `psdb` rake task to connect to your branch and run `db:migrate`. The command will run against
+the branch specified in your `.pscale.yml` file.
 
 ```
 bundle exec rails psdb:migrate
@@ -59,8 +59,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.
@@ -72,6 +70,9 @@ 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.
 
+## Usage with GitHub Actions
+
+See the [GitHub Actions examples](actions-example.md) doc for ways to automate your schema migrations with PlanetScale + Actions.
 
 ## Development
 

data/actions-example.md

@@ -0,0 +1,129 @@
+## GitHub Actions example
+
+To automate branch creation and running migrations, you can setup a branch and run `rails psdb:migrate` from GitHub Actions.
+
+Here is a full example workflow that:
+1. Creates a branch matching the git branch name.
+2. Runs rails migrations.
+3. Opens a deploy request if any migrations were run.
+4. Comments on the pull request with the diff + link to the deploy request.
+
+### Migrate schema workflow
+
+This workflow will run on any pull request that is opened with a change to `db/schema.rb`.
+
+Secrets needed to be set:
+- `PLANETSCALE_ORG_NAME`
+- `PLANETSCALE_DATABASE_NAME`
+- `PLANETSCALE_SERVICE_TOKEN_ID`
+- `PLANETSCALE_SERVICE_TOKEN`
+
+The PlanetScale service token must have the `connect_branch`, `create_branch`, `read_branch`, `create_deploy_request`, and `read_deploy_request` permissions on the database.
+
+```yaml
+name: Run database migrations
+on: 
+  pull_request:
+    branches: [ main ]
+    paths:
+      - 'db/schema.rb'
+
+jobs:
+  planetscale:
+    permissions: 
+      pull-requests: write
+      contents: read
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+      - name: Create a branch
+        uses: planetscale/create-branch-action@v4
+        id: create_branch
+        with:
+          org_name: ${{ secrets.PLANETSCALE_ORG_NAME }}
+          database_name: ${{ secrets.PLANETSCALE_DATABASE_NAME }}
+          branch_name: ${{ github.head_ref }}
+          from: main
+          check_exists: true
+          wait: true
+        env:
+          PLANETSCALE_SERVICE_TOKEN_ID: ${{ secrets.PLANETSCALE_SERVICE_TOKEN_ID }}
+          PLANETSCALE_SERVICE_TOKEN: ${{ secrets.PLANETSCALE_SERVICE_TOKEN }}
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2.1
+      - name: Cache Ruby gems
+        uses: actions/cache@v3
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+      - name: Install dependencies
+        run: |
+          bundle config --local path vendor/bundle
+          bundle config --local deployment true
+          bundle install
+      - name: Set migration config
+        run: |
+          echo "org: ${{ secrets.PLANETSCALE_ORG_NAME }}" > .pscale.yml
+          echo "database: ${{ secrets.PLANETSCALE_DATABASE_NAME }}" >> .pscale.yml
+          echo "branch: ${{ github.head_ref }}" >> .pscale.yml
+      - name: Setup pscale
+        uses: planetscale/setup-pscale-action@v1
+      - name: Run migrations
+        run: |
+          bundle exec rails psdb:migrate > migration-output.txt
+        env:
+          PSCALE_SERVICE_TOKEN_ID: ${{ secrets.PLANETSCALE_SERVICE_TOKEN_ID }}
+          PSCALE_SERVICE_TOKEN: ${{ secrets.PLANETSCALE_SERVICE_TOKEN }}
+      - name: Open DR if migrations
+        run: |
+          if grep -q "migrated" migration-output.txt; then
+            echo "DB_MIGRATED=true" >> $GITHUB_ENV
+            if pscale deploy-request create ${{ secrets.PLANETSCALE_DATABASE_NAME }} ${{ github.head_ref }}; then
+              cat migration-output.txt
+              echo "DR_OPENED=true" >> $GITHUB_ENV
+              echo "Deploy request successfully opened"
+            else
+              echo "Error: Deployment request failed"
+              exit 0
+            fi
+          else
+            echo "Did not open a DR since nothing found in migration-output.txt"
+            cat migration-output.txt
+            exit 0
+          fi
+        env:
+          PLANETSCALE_SERVICE_TOKEN_ID: ${{ secrets.PLANETSCALE_SERVICE_TOKEN_ID }}
+          PLANETSCALE_SERVICE_TOKEN: ${{ secrets.PLANETSCALE_SERVICE_TOKEN }}
+      - name: Get Deploy Requests
+        if: ${{ env.DR_OPENED }}
+        env:
+          PLANETSCALE_SERVICE_TOKEN_ID: ${{ secrets.PLANETSCALE_SERVICE_TOKEN_ID }}
+          PLANETSCALE_SERVICE_TOKEN: ${{ secrets.PLANETSCALE_SERVICE_TOKEN }}
+        run: |
+          deploy_request_number=$(pscale deploy-request show ${{ secrets.PLANETSCALE_DATABASE_NAME }} ${{ github.head_ref }} -f json | jq -r '.number')
+          echo "DEPLOY_REQUEST_NUMBER=$deploy_request_number" >> $GITHUB_ENV
+      - name: Comment PR - db migrated
+        if: ${{ env.DR_OPENED }}
+        env:
+          PLANETSCALE_SERVICE_TOKEN_ID: ${{ secrets.PLANETSCALE_SERVICE_TOKEN_ID }}
+          PLANETSCALE_SERVICE_TOKEN: ${{ secrets.PLANETSCALE_SERVICE_TOKEN }}
+        run: |
+          sleep 2
+          echo "Deploy request opened: https://app.planetscale.com/${{ secrets.PLANETSCALE_ORG_NAME }}/${{ secrets.PLANETSCALE_DATABASE_NAME }}/deploy-requests/${{ env.DEPLOY_REQUEST_NUMBER }}" >> migration-message.txt
+          echo "" >> migration-message.txt
+          echo "\`\`\`diff" >> migration-message.txt
+          pscale deploy-request diff ${{ secrets.PLANETSCALE_DATABASE_NAME }} ${{ env.DEPLOY_REQUEST_NUMBER }}  -f json | jq -r '.[].raw' >> migration-message.txt
+          echo "\`\`\`" >> migration-message.txt
+      - name: Comment PR - db migrated
+        uses: thollander/actions-comment-pull-request@v2
+        if: ${{ env.DR_OPENED }}
+        with:
+          filePath: migration-message.txt
+```

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,92 +55,53 @@ 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)
+      raise "Could not determine which PlanetScale branch to use from .pscale.yml. Please switch to a branch by using: `pscale switch database-name branch-name`".colorize(:red)
     end
 
-    r, = PTY.open
+    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"]}"
 
-    puts "Connecting to PlanetScale..."
+    output = `#{command}`
 
-    # 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 $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"]
 
-    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
+      adapter = "mysql2"
 
-    raise "Timed out waiting for PlanetScale connection to be established".colorize(:red) if time_elapsed > 10.seconds
-  ensure
-    r&.close
-  end
-
-  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
-        raise "Unable to run migrations against the main branch" if branch == "main"
-
-        config = Rails.configuration.database_configuration[Rails.env][name]
-
-        raise "Database #{name} is not configured for the current environment" unless config
-
-        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
-        end
-
-        raise "Timed out waiting for PlanetScale connection to be established" if time_elapsed > 10.seconds
-
-        # 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 defined?(Trilogy)
+        adapter = "trilogy"
       end
+
+      "#{adapter}://#{username}:#{password}@#{host}:3306/#{database}?ssl_mode=VERIFY_IDENTITY"
+    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
@@ -131,41 +109,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
@@ -173,31 +155,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
+          rails "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.3"
+  VERSION = "0.2.0"
 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.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Mike Coutermarsh
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-18 00:00:00.000000000 Z
+date: 2023-11-09 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:
@@ -60,6 +66,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- actions-example.md
 - bin/console
 - bin/setup
 - lib/Rakefile