heroku_tool 0.9.2 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b5e399a4542b07992fbc0e896bf8b1f6fca73cb3abf66647c0c741e013ee910
-  data.tar.gz: b06141618a185a433edbb74786d6ea572a0079220bf22f4f6724b87a86e8ac30
+  metadata.gz: 87a4838bb986b0cb1c7404a967443c0ad1015718a755733fb58b7bdfd78b4e1c
+  data.tar.gz: 5d8e1560f6211c8cee8006c74a7dc7f6b50994dbedd43d5dc0755d939ac0c1dd
 SHA512:
-  metadata.gz: 54d7a075669af48e1a62a59cf077ce577114e565487b1997f0bad47edb2f26c74250a82ea9b501f058ef66ec4ec4157086ba3c96aaed66f163b24c70aa2b7096
-  data.tar.gz: ea5187d7722b88eb0cf01065ae624f65effa27457257a3e6081b22294dbc3e893a0d3d74c0cff36cbd7a38c01c51a1b68db057688c9a1fc27789fab6c8dde047
+  metadata.gz: 6c5aac4e33eb719b8f2ccde8b8d6d7198323cbb42f92c7a711b020919b7b59ba022a7d9e92bfc41a8d0bf2ab41d348978fac25d48d84851494c7ef95b1c46312
+  data.tar.gz: ee4cfec74f3d1cf448eafb606d3ee9712c200bd17b86ba8a606e79a6bfb805d4b36e82bd2b220ca40039662dbadd2de535ca8b08eca3b03c424b203f6cbed0ba

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## v0.9.4
+
+- `heroku:db:from_dump` restores with parallel jobs: `--jobs`, default 4 (use `--jobs 1` for the old behaviour)
+- `Configuration#skip_table_data` lists tables whose data `from_dump` leaves out (the tables are still created, empty); `--all-data` restores them anyway
+
+## v0.9.3
+
+record the app revision using git describe, at the beginning of the process (in case of accidental branch switches)
+
+## v0.9.2
+
+update and fix bugsnag deploy tracking
+
 ## v0.9.1
 
 support url in heroku targets

data/README.md

@@ -93,6 +93,14 @@ Sync a database down from remote to local
 
 _FYI rake db:drop_all_tables is handy as it doesn't require you to disconnect any running processes from the database._
 
+`from_dump` restores with 4 parallel jobs (`--jobs N` to change). To leave out the data of
+large tables you don't need locally (an audit table, say), list them in your configuration;
+the tables are still created, just empty, and `--all-data` restores everything:
+
+    def skip_table_data
+      %w[versions]
+    end
+
 Copy production db to staging
 
     thor heroku:sync:to staging -f production

data/lib/heroku_tool/commander.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "open3"
+require "shellwords"
 
 module HerokuTool
   class Commander
@@ -14,13 +15,21 @@ module HerokuTool
       @configuration = configuration
     end
 
+    # The deploy ref is resolved to a commit once, before anything else happens, and that commit is what gets
+    # described, pushed and recorded: checking out another branch (or fetching) while the deploy is running
+    # doesn't change what is deployed or how it is reported.
+    #
+    # @return [String, false] the revision (commit sha) that was deployed, or false if the deploy failed
     def deploy(deploy_ref, with_maintenance:)
-      deploy_ref_description = deploy_ref_describe(deploy_ref)
+      revision = resolve_revision(deploy_ref)
+      return false unless revision
+
+      deploy_ref_description = deploy_ref_describe(revision)
       puts "Deploy #{deploy_ref_description} to #{target} with migrate=#{target.migrate_in_release_phase ? "(during release phase)" : migrate_outside_of_release_phase?} with_maintenance=#{with_maintenance} "
 
-      output_to_be_deployed(deploy_ref)
+      output_to_be_deployed(revision)
       configuration.before_deploying(self, target, deploy_ref_description)
-      successful_push = puts_and_system "git push -f #{target.git_remote} #{deploy_ref || target}^{}:#{target.heroku_target_ref}"
+      successful_push = puts_and_system "git push -f #{target.git_remote} #{revision}:#{target.heroku_target_ref}"
 
       return false unless successful_push
 
@@ -32,12 +41,22 @@ module HerokuTool
       app_revision_env_var = configuration.app_revision_env_var
       if app_revision_env_var && app_revision_env_var != "HEROKU_SLUG_COMMIT"
         # HEROKU_SLUG_COMMIT is automatically set by https://devcenter.heroku.com/articles/dyno-metadata
-        puts_and_system %{heroku config:set #{app_revision_env_var}=$(git describe --always #{deploy_ref}) -a #{target.heroku_app}}
+        puts_and_system "heroku config:set #{app_revision_env_var}=#{Shellwords.escape(deploy_ref_description)} -a #{target.heroku_app}"
       end
 
       maintenance_off if with_maintenance
       configuration.after_deploying(self, target, deploy_ref_description)
-      true
+      revision
+    end
+
+    # @return [String, nil] the sha of the commit that deploy_ref (or the target's deploy_ref) points at right now
+    def resolve_revision(deploy_ref = nil)
+      deploy_ref ||= target.deploy_ref
+      revision = `git rev-parse --verify --quiet #{deploy_ref}^{commit}`.strip
+      return revision unless revision.empty?
+
+      puts "❌ Can't resolve '#{deploy_ref}' to a commit"
+      nil
     end
 
     def maintenance_on
@@ -55,7 +74,7 @@ module HerokuTool
     end
 
     def deploy_ref_describe(deploy_ref = nil)
-      `git describe #{deploy_ref || target.deploy_ref}`.strip
+      `git describe --always #{deploy_ref || target.deploy_ref}`.strip
     end
 
     def output_to_be_deployed(since_deploy_ref = nil)

data/lib/heroku_tool/configuration.rb

@@ -36,6 +36,12 @@ module HerokuTool
       end
     end
 
+    # tables whose data heroku:db:from_dump leaves out (the tables are still created, empty),
+    # e.g. %w[versions] for a large audit table you don't need locally
+    def skip_table_data
+      []
+    end
+
     def after_sync_down(instance)
       # could add source ?
       instance.puts_and_system "rails db:migrate"

data/lib/heroku_tool/tasks/heroku.thor

@@ -135,9 +135,9 @@ class Heroku < Thor
     check_deploy_ref(deploy_ref)
     with_maintenance = options[:maintenance].nil? && migrate_outside_of_release_phase? || options[:maintenance] || false
     deploy_ref ||= target.deploy_ref
-    success = commander.deploy(deploy_ref, with_maintenance: with_maintenance)
-    if success
-      deploy_tracking(target_name, deploy_ref)
+    deployed_revision = commander.deploy(deploy_ref, with_maintenance: with_maintenance)
+    if deployed_revision
+      deploy_tracking(target_name, deployed_revision)
     else
       exit(-1)
     end
@@ -318,15 +318,35 @@ class Heroku < Thor
     desc "from_dump --from SOURCE_TARGET", "make the db the same as the last target dump from SOURCE_TARGET"
 
     method_option :just_restore, default: false, desc: "Just do restore without post-actions", type: :boolean
+    method_option :all_data, default: false, desc: "Also restore the data of the tables in Configuration#skip_table_data", type: :boolean
+    method_option :jobs, default: 4, desc: "Number of parallel pg_restore jobs", type: :numeric
 
     def from_dump
       invoke "warn", [], from: options[:from]
       source = lookup_heroku(options[:from])
       db_config = ::HerokuTool::DbConfiguration.new
-      puts_and_system "pg_restore --verbose --clean --no-acl --no-owner -h localhost #{db_config.user_arg} -d #{db_config.database} #{source.dump_filename}"
+      puts_and_system "pg_restore --verbose --clean --no-acl --no-owner -j #{options[:jobs]} #{restore_list_arg(source)}-h localhost #{db_config.user_arg} -d #{db_config.database} #{source.dump_filename}"
       configuration.after_sync_down(self) unless options[:just_restore]
     end
 
+    no_commands do
+      # @return [String] "-L <list> " naming a copy of the dump's table of contents with the
+      #   data of Configuration#skip_table_data commented out, or "" when nothing is skipped
+      def restore_list_arg(source)
+        tables = options[:all_data] ? [] : configuration.skip_table_data
+        return "" if tables.empty?
+
+        toc, status = Open3.capture2("pg_restore", "-l", source.dump_filename)
+        raise Thor::Error, "pg_restore -l #{source.dump_filename} failed" unless status.success?
+
+        patterns = tables.map { |table| / TABLE DATA public #{Regexp.escape(table)} / }
+        list = toc.lines.map { |line| (patterns.any? { |pattern| line.match?(pattern) }) ? ";#{line}" : line }
+        list_filename = "#{source.dump_filename}.list"
+        File.write(list_filename, list.join)
+        "-L #{list_filename} "
+      end
+    end
+
     desc "dump_to_tmp", "dump to tmp directory"
     method_option(:from, type: :string, default: "local", desc: "heroku target (defaults to local)", required: false, aliases: "f")
 

data/lib/heroku_tool/version.rb

@@ -1,3 +1,3 @@
 module HerokuTool
-  VERSION = "0.9.2"
+  VERSION = "0.9.4"
 end

data/templates/heroku.thor

@@ -37,6 +37,10 @@ class Heroku
     #  instance.puts_and_system "rake dev:dev_data"
     # end
     #
+    # def skip_table_data
+    #  %w[versions]
+    # end
+    #
     # def after_sync_to(instance, target)
     #  super
     #  instance.puts_and_system %(heroku run rake dev:staging_data -a #{target.heroku_app})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroku_tool
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.4
 platform: ruby
 authors:
 - Tim Diggins
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.11
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Tool for configurable one-shot deployment and db managment with heroku and
   rails