aptible-cli 0.24.2 → 0.24.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a86dab95f37f3e63919dd105b9eca70af63753165bfa6fb2436e626844831bdd
-  data.tar.gz: 01ee1b79365b6a8cbb1399843de3abbc7857e061c6b376ac57b355a55c34e8f6
+  metadata.gz: f23bd0dde480e09b51d6876d15ff0628739d632197ae600bc2bc567bd54d7ee9
+  data.tar.gz: 7c2952e17c06a6c9593a5cbcbb3898e333d2c5e2a6d32bff053cd42798e87287
 SHA512:
-  metadata.gz: 404722114100e706aee73134ad66100f5ddeaf71417eea3b8ac065c493acd17f5a2464a0542233fc0fe20af3b26d4b0fc3598ac87b799396238cbf05bc559738
-  data.tar.gz: 2c3a6d45e49401f49ef01985a927f221c029c724ef79993388a42dded813989a57868636d4c4b313a6decb756255dbbb9bce08e67770a3ba7fea654ea18bf946
+  metadata.gz: b41752dc657d784ed2cc6da0ed4bc2c54f730adc59b02de4120d30aed2c6626b93a25b6049551051a17f1f6c841c9cac200f70eb480c1330c37543440e3d431e
+  data.tar.gz: 0f3a5c06f634a87ff7768914f8d383a86bbee84a4c6dc511797f752bdc777f29bd4882d46e8b93e53124d35fba16e1a0589cae9355e16c17392c9026322e3b69

data/.github/workflows/test.yml

@@ -11,7 +11,7 @@ on:
 jobs:
   test:
     name: Build and Publish
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    aptible-cli (0.24.2)
+    aptible-cli (0.24.3)
       activesupport (>= 4.0, < 6.0)
       aptible-api (~> 1.6.5)
       aptible-auth (~> 1.2.5)

data/lib/aptible/cli/agent.rb

@@ -1,5 +1,6 @@
 require 'base64'
 require 'uri'
+require 'logger'
 
 require 'aptible/auth'
 require 'thor'
@@ -8,6 +9,7 @@ require 'chronic_duration'
 
 require_relative 'helpers/ssh'
 require_relative 'helpers/token'
+require_relative 'helpers/telemetry'
 require_relative 'helpers/operation'
 require_relative 'helpers/environment'
 require_relative 'helpers/app'
@@ -80,7 +82,13 @@ module Aptible
 
       def initialize(*)
         nag_toolbelt unless toolbelt?
-        Aptible::Resource.configure { |conf| conf.user_agent = version_string }
+        Aptible::Resource.configure do |conf|
+          conf.user_agent = version_string
+          level = Logger::WARN
+          debug_level = ENV['APTIBLE_DEBUG']
+          level = debug_level if debug_level
+          conf.logger.tap { |l| l.level = level }
+        end
         warn_sso_enforcement
         super
       end

data/lib/aptible/cli/helpers/app.rb

@@ -151,12 +151,27 @@ module Aptible
           service
         end
 
+        def apps_href
+          href = '/apps'
+          if Renderer.format != 'json'
+            href = '/apps?per_page=5000&no_embed=true'
+          end
+          href
+        end
+
+        def apps_all
+          Aptible::Api::App.all(
+            token: fetch_token,
+            href: apps_href
+          )
+        end
+
         def apps_from_handle(handle, environment)
           # TODO: This should probably use each_app for more efficiency.
           if environment
             environment.apps
           else
-            Aptible::Api::App.all(token: fetch_token)
+            apps_all
           end.select { |a| a.handle == handle }
         end
 

data/lib/aptible/cli/helpers/database.rb

@@ -31,12 +31,27 @@ module Aptible
           end
         end
 
-        def databases_from_handle(handle, environment)
-          if environment
-            databases = environment.databases
-          else
-            databases = Aptible::Api::Database.all(token: fetch_token)
+        def databases_href
+          href = '/databases'
+          if Renderer.format != 'json'
+            href = '/databases?per_page=5000&no_embed=true'
           end
+          href
+        end
+
+        def databases_all
+          Aptible::Api::Database.all(
+            token: fetch_token,
+            href: databases_href
+          )
+        end
+
+        def databases_from_handle(handle, environment)
+          databases = if environment
+                        environment.databases
+                      else
+                        databases_all
+                      end
           databases.select { |a| a.handle == handle }
         end
 

data/lib/aptible/cli/helpers/environment.rb

@@ -6,6 +6,14 @@ module Aptible
       module Environment
         include Helpers::Token
 
+        def environment_href
+          href = '/accounts'
+          if Renderer.format != 'json'
+            href = '/accounts?per_page=5000&no_embed=true'
+          end
+          href
+        end
+
         def scoped_environments(options)
           if options[:environment]
             if (environment = environment_from_handle(options[:environment]))
@@ -14,7 +22,11 @@ module Aptible
               raise Thor::Error, 'Specified account does not exist'
             end
           else
-            Aptible::Api::Account.all(token: fetch_token)
+            href = environment_href
+            Aptible::Api::Account.all(
+              token: fetch_token,
+              href: href
+            )
           end
         end
 
@@ -30,13 +42,26 @@ module Aptible
 
         def environment_from_handle(handle)
           return nil unless handle
-          Aptible::Api::Account.all(token: fetch_token).find do |a|
+          href = environment_href
+          Aptible::Api::Account.all(token: fetch_token, href: href).find do |a|
             a.handle == handle
           end
         end
 
+        def environment_map(accounts)
+          acc_map = {}
+          accounts.each do |account|
+            acc_map[account.links.self.href] = account
+          end
+          acc_map
+        end
+
         def ensure_default_environment
-          environments = Aptible::Api::Account.all(token: fetch_token)
+          href = environment_href
+          environments = Aptible::Api::Account.all(
+            token: fetch_token,
+            href: href
+          )
           case environments.count
           when 0
             e = 'No environments. Go to https://app.aptible.com/ to proceed'

data/lib/aptible/cli/helpers/telemetry.rb

@@ -0,0 +1,58 @@
+require 'httpclient'
+require 'securerandom'
+require 'uri'
+
+module Aptible
+  module CLI
+    module Helpers
+      module Telemetry
+        def telemetry(cmd, options = {})
+          token_hash = decode_token
+          format = Renderer.format
+          format = 'text' if format.nil?
+          sub = token_hash[0]['sub']
+          parsed_url = URI.parse(sub)
+          path_components = parsed_url.path.split('/')
+          user_or_org_id = path_components.last
+          # https://github.com/aptible/aptible-resource/blob/7c3a79e6eee9c88aa7dbf332e550508f22a5b08d/lib/hyper_resource/modules/http.rb#L21
+          client = HTTPClient.new.tap do |c|
+            c.cookie_manager = nil
+            c.connect_timeout = 30
+            c.send_timeout = 45
+            c.keep_alive_timeout = 15
+            c.ssl_config.set_default_paths
+          end
+
+          value = {
+            'email' => token_hash[0]['email'],
+            'format' => format,
+            'cmd' => cmd,
+            'options' => options,
+            'version' => version_string,
+            # https://stackoverflow.com/a/73973555
+            'github' => ENV['GITHUB_ACTIONS'],
+            'gitlab' => ENV['GITLAB_CI'],
+            'travis' => ENV['TRAVIS'],
+            'circleci' => ENV['CIRCLECI'],
+            'ci' => ENV['CI']
+          }
+
+          begin
+            uri = URI('https://tuna.aptible.com/www/e')
+            client.get(
+              uri,
+              'id' => SecureRandom.uuid,
+              'user_id' => user_or_org_id,
+              'type' => 'cli_telemetry',
+              'url' => sub,
+              'value' => value
+            )
+          rescue
+            # since this is just for telemetry we don't want to notify
+            # user of an error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aptible/cli/helpers/token.rb

@@ -1,4 +1,5 @@
 require 'aptible/auth'
+require 'jwt'
 
 require_relative 'config_path'
 
@@ -46,6 +47,11 @@ module Aptible
         def token_file
           File.join(aptible_config_path, 'tokens.json').freeze
         end
+
+        def decode_token
+          tok = fetch_token
+          JWT.decode(tok, nil, false)
+        end
       end
     end
   end

data/lib/aptible/cli/renderer.rb

@@ -9,8 +9,12 @@ module Aptible
     module Renderer
       FORMAT_VAR = 'APTIBLE_OUTPUT_FORMAT'.freeze
 
+      def self.format
+        ENV[FORMAT_VAR]
+      end
+
       def self.current
-        case (format = ENV[FORMAT_VAR])
+        case format
         when 'json'
           Json.new
         when 'text'

data/lib/aptible/cli/resource_formatter.rb

@@ -108,6 +108,13 @@ module Aptible
           attach_account(node, account)
         end
 
+        def inject_database_minimal(node, database, account)
+          node.value('id', database.id)
+          node.value('handle', database.handle)
+          node.value('created_at', database.created_at)
+          attach_account(node, account)
+        end
+
         def inject_database(node, database, account)
           node.value('id', database.id)
           node.value('handle', database.handle)

data/lib/aptible/cli/subcommands/apps.rb

@@ -7,17 +7,34 @@ module Aptible
             include Helpers::App
             include Helpers::Environment
             include Helpers::Token
+            include Helpers::Telemetry
 
             desc 'apps', 'List all applications'
             option :environment, aliases: '--env'
             def apps
+              telemetry(__method__, options)
+
               Formatter.render(Renderer.current) do |root|
                 root.grouped_keyed_list(
                   { 'environment' => 'handle' },
                   'handle'
                 ) do |node|
-                  scoped_environments(options).each do |account|
-                    account.each_app do |app|
+                  accounts = scoped_environments(options)
+                  acc_map = environment_map(accounts)
+
+                  if Renderer.format == 'json'
+                    accounts.each do |account|
+                      account.each_app do |app|
+                        node.object do |n|
+                          ResourceFormatter.inject_app(n, app, account)
+                        end
+                      end
+                    end
+                  else
+                    apps_all.each do |app|
+                      account = acc_map[app.links.account.href]
+                      next if account.nil?
+
                       node.object do |n|
                         ResourceFormatter.inject_app(n, app, account)
                       end
@@ -30,6 +47,8 @@ module Aptible
             desc 'apps:create HANDLE', 'Create a new application'
             option :environment, aliases: '--env'
             define_method 'apps:create' do |handle|
+              telemetry(__method__, options.merge(handle: handle))
+
               environment = ensure_environment(options)
               app = environment.create_app(handle: handle)
 
@@ -56,6 +75,8 @@ module Aptible
             option :container_profile, type: :string,
                                        desc: 'Examples: m c r'
             define_method 'apps:scale' do |type|
+              telemetry(__method__, options.merge(type: type))
+
               service = ensure_service(options, type)
 
               container_count = options[:container_count]
@@ -89,6 +110,8 @@ module Aptible
             desc 'apps:deprovision', 'Deprovision an app'
             app_options
             define_method 'apps:deprovision' do
+              telemetry(__method__, options)
+
               app = ensure_app(options)
               CLI.logger.info "Deprovisioning #{app.handle}..."
               op = app.create_operation!(type: 'deprovision')
@@ -108,6 +131,12 @@ module Aptible
                  ' drain destinations, you must restart the app.'
             option :environment, aliases: '--env'
             define_method 'apps:rename' do |old_handle, new_handle|
+              opts = options.merge(
+                old_handle: old_handle,
+                new_handle: new_handle
+              )
+              telemetry(__method__, opts)
+
               env = ensure_environment(options)
               app = ensure_app(options.merge(app: old_handle))
               app.update!(handle: new_handle)

data/lib/aptible/cli/subcommands/backup.rb

@@ -6,6 +6,7 @@ module Aptible
           thor.class_eval do
             include Helpers::Token
             include Helpers::Database
+            include Helpers::Telemetry
 
             desc 'backup:restore BACKUP_ID ' \
                  '[--environment ENVIRONMENT_HANDLE] [--handle HANDLE] ' \
@@ -24,6 +25,8 @@ module Aptible
                                        desc: 'Examples: m c r'
             option :iops, type: :numeric
             define_method 'backup:restore' do |backup_id|
+              telemetry(__method__, options.merge(backup_id: backup_id))
+
               backup = Aptible::Api::Backup.find(backup_id, token: fetch_token)
               raise Thor::Error, "Backup ##{backup_id} not found" if backup.nil?
 
@@ -74,6 +77,8 @@ module Aptible
                    default: '99y',
                    desc: 'Limit backups returned (example usage: 1w, 1y, etc.)'
             define_method 'backup:list' do |handle|
+              telemetry(__method__, options.merge(handle: handle))
+
               age = ChronicDuration.parse(options[:max_age])
               raise Thor::Error, "Invalid age: #{options[:max_age]}" if age.nil?
               min_created_at = Time.now - age
@@ -101,6 +106,8 @@ module Aptible
                              desc: 'Limit backups returned '\
                                    '(example usage: 1w, 1y, etc.)'
             define_method 'backup:orphaned' do
+              telemetry(__method__, options)
+
               age = ChronicDuration.parse(options[:max_age])
               raise Thor::Error, "Invalid age: #{options[:max_age]}" if age.nil?
               min_created_at = Time.now - age
@@ -126,6 +133,8 @@ module Aptible
             desc 'backup:purge BACKUP_ID',
                  'Permanently delete a backup and any copies of it'
             define_method 'backup:purge' do |backup_id|
+              telemetry(__method__, options.merge(backup_id: backup_id))
+
               backup = Aptible::Api::Backup.find(backup_id, token: fetch_token)
               raise Thor::Error, "Backup ##{backup_id} not found" if backup.nil?
 

data/lib/aptible/cli/subcommands/backup_retention_policy.rb

@@ -10,10 +10,13 @@ module Aptible
           thor.class_eval do
             include Helpers::Environment
             include Term::ANSIColor
+            include Helpers::Telemetry
 
             desc 'backup_retention_policy [ENVIRONMENT_HANDLE]',
                  'Show the current backup retention policy for the environment'
             define_method 'backup_retention_policy' do |env|
+              telemetry(__method__, options.merge(env: env))
+
               account = ensure_environment(environment: env)
               policy = account.backup_retention_policies.first
               unless policy
@@ -52,6 +55,8 @@ module Aptible
                    desc: 'Do not prompt for confirmation if the new policy ' \
                          'retains fewer backups than the current policy'
             define_method 'backup_retention_policy:set' do |env|
+              telemetry(__method__, options.merge(env: env))
+
               if options.empty?
                 raise Thor::Error,
                       'Please specify at least one attribute to change'

data/lib/aptible/cli/subcommands/config.rb

@@ -7,10 +7,13 @@ module Aptible
           thor.class_eval do
             include Helpers::Operation
             include Helpers::App
+            include Helpers::Telemetry
 
             desc 'config', "Print an app's current configuration"
             app_options
             def config
+              telemetry(__method__, options)
+
               app = ensure_app(options)
               config = app.current_configuration
               env = config ? config.env : {}
@@ -32,6 +35,8 @@ module Aptible
                  "Print a specific key within an app's current configuration"
             app_options
             define_method 'config:get' do |*args|
+              telemetry(__method__, options)
+
               app = ensure_app(options)
               config = app.current_configuration
               env = config ? config.env : {}
@@ -49,6 +54,8 @@ module Aptible
                  'Add an ENV variable to an app'
             app_options
             define_method 'config:add' do |*args|
+              telemetry(__method__, options)
+
               # FIXME: define_method - ?! Seriously, WTF Thor.
               app = ensure_app(options)
               env = extract_env(args)
@@ -61,6 +68,7 @@ module Aptible
                  'Add an ENV variable to an app'
             app_options
             define_method 'config:set' do |*args|
+              telemetry(__method__, options)
               send('config:add', *args)
             end
 
@@ -68,6 +76,8 @@ module Aptible
                  'Remove an ENV variable from an app'
             app_options
             define_method 'config:rm' do |*args|
+              telemetry(__method__, options)
+
               # FIXME: define_method - ?! Seriously, WTF Thor.
               app = ensure_app(options)
               env = Hash[args.map do |arg|
@@ -84,6 +94,7 @@ module Aptible
                  'Remove an ENV variable from an app'
             app_options
             define_method 'config:unset' do |*args|
+              telemetry(__method__, options)
               send('config:rm', *args)
             end
           end

data/lib/aptible/cli/subcommands/db.rb

@@ -12,19 +12,40 @@ module Aptible
             include Helpers::Database
             include Helpers::Token
             include Term::ANSIColor
+            include Helpers::Telemetry
 
             desc 'db:list', 'List all databases'
             option :environment, aliases: '--env'
             define_method 'db:list' do
+              telemetry(__method__, options)
+
               Formatter.render(Renderer.current) do |root|
                 root.grouped_keyed_list(
                   { 'environment' => 'handle' },
                   'handle'
                 ) do |node|
-                  scoped_environments(options).each do |account|
-                    account.each_database do |db|
+                  accounts = scoped_environments(options)
+                  acc_map = environment_map(accounts)
+
+                  if Renderer.format == 'json'
+                    accounts.each do |account|
+                      account.each_database do |db|
+                        node.object do |n|
+                          ResourceFormatter.inject_database(n, db, account)
+                        end
+                      end
+                    end
+                  else
+                    databases_all.each do |db|
+                      account = acc_map[db.links.account.href]
+                      next if account.nil?
+
                       node.object do |n|
-                        ResourceFormatter.inject_database(n, db, account)
+                        ResourceFormatter.inject_database_minimal(
+                          n,
+                          db,
+                          account
+                        )
                       end
                     end
                   end
@@ -34,6 +55,8 @@ module Aptible
 
             desc 'db:versions', 'List available database versions'
             define_method 'db:versions' do
+              telemetry(__method__, options)
+
               Formatter.render(Renderer.current) do |root|
                 root.grouped_keyed_list('type', 'version') do |node|
                   Aptible::Api::DatabaseImage.all(
@@ -68,6 +91,8 @@ module Aptible
                                        desc: 'Examples: m c r'
             option :iops, type: :numeric
             define_method 'db:create' do |handle|
+              telemetry(__method__, options.merge(handle: handle))
+
               account = ensure_environment(options)
 
               db_opts = {
@@ -128,6 +153,12 @@ module Aptible
             desc 'db:clone SOURCE DEST', 'Clone a database to create a new one'
             option :environment, aliases: '--env'
             define_method 'db:clone' do |source_handle, dest_handle|
+              opts = options.merge(
+                source_handle: source_handle,
+                dest_handle: dest_handle
+              )
+              telemetry(__method__, opts)
+
               # TODO: Deprecate + recommend backup
               source = ensure_database(options.merge(db: source_handle))
               database = clone_database(source, dest_handle)
@@ -150,6 +181,12 @@ module Aptible
                                        desc: 'Examples: m c r'
             option :iops, type: :numeric
             define_method 'db:replicate' do |source_handle, dest_handle|
+              opts = options.merge(
+                source_handle: source_handle,
+                dest_handle: dest_handle
+              )
+              telemetry(__method__, opts)
+
               source = ensure_database(options.merge(db: source_handle))
 
               if options[:logical]
@@ -193,6 +230,8 @@ module Aptible
                  'Dump a remote database to file'
             option :environment, aliases: '--env'
             define_method 'db:dump' do |handle, *dump_options|
+              telemetry(__method__, options.merge(handle: handle))
+
               database = ensure_database(options.merge(db: handle))
               with_postgres_tunnel(database) do |url|
                 filename = "#{handle}.dump"
@@ -207,6 +246,12 @@ module Aptible
             option :environment, aliases: '--env'
             option :on_error_stop, type: :boolean
             define_method 'db:execute' do |handle, sql_path|
+              opts = options.merge(
+                handle: handle,
+                sql_path: sql_path
+              )
+              telemetry(__method__, opts)
+
               database = ensure_database(options.merge(db: handle))
               with_postgres_tunnel(database) do |url|
                 CLI.logger.info "Executing #{sql_path} against #{handle}"
@@ -221,6 +266,8 @@ module Aptible
             option :port, type: :numeric
             option :type, type: :string
             define_method 'db:tunnel' do |handle|
+              telemetry(__method__, options.merge(handle: handle))
+
               desired_port = Integer(options[:port] || 0)
               database = ensure_database(options.merge(db: handle))
 
@@ -264,6 +311,8 @@ module Aptible
             desc 'db:deprovision HANDLE', 'Deprovision a database'
             option :environment, aliases: '--env'
             define_method 'db:deprovision' do |handle|
+              telemetry(__method__, options.merge(handle: handle))
+
               database = ensure_database(options.merge(db: handle))
               CLI.logger.info "Deprovisioning #{database.handle}..."
               op = database.create_operation!(type: 'deprovision')
@@ -280,6 +329,8 @@ module Aptible
             desc 'db:backup HANDLE', 'Backup a database'
             option :environment, aliases: '--env'
             define_method 'db:backup' do |handle|
+              telemetry(__method__, options.merge(handle: handle))
+
               database = ensure_database(options.merge(db: handle))
               CLI.logger.info "Backing up #{database.handle}..."
               op = database.create_operation!(type: 'backup')
@@ -289,6 +340,8 @@ module Aptible
             desc 'db:reload HANDLE', 'Reload a database'
             option :environment, aliases: '--env'
             define_method 'db:reload' do |handle|
+              telemetry(__method__, options.merge(handle: handle))
+
               database = ensure_database(options.merge(db: handle))
               CLI.logger.info "Reloading #{database.handle}..."
               op = database.create_operation!(type: 'reload')
@@ -309,6 +362,8 @@ module Aptible
             option :iops, type: :numeric
             option :volume_type
             define_method 'db:restart' do |handle|
+              telemetry(__method__, options.merge(handle: handle))
+
               database = ensure_database(options.merge(db: handle))
 
               opts = {
@@ -339,6 +394,8 @@ module Aptible
             option :iops, type: :numeric
             option :volume_type
             define_method 'db:modify' do |handle|
+              telemetry(__method__, options.merge(handle: handle))
+
               database = ensure_database(options.merge(db: handle))
 
               opts = {
@@ -357,6 +414,8 @@ module Aptible
             option :environment, aliases: '--env'
             option :type, type: :string
             define_method 'db:url' do |handle|
+              telemetry(__method__, options.merge(handle: handle))
+
               database = ensure_database(options.merge(db: handle))
               credential = find_credential(database, options[:type])
 
@@ -373,6 +432,12 @@ module Aptible
                  ' metric drain destinations, you must reload the database.'
             option :environment, aliases: '--env'
             define_method 'db:rename' do |old_handle, new_handle|
+              opts = options.merge(
+                old_handle: old_handle,
+                new_handle: new_handle
+              )
+              telemetry(__method__, opts)
+
               env = ensure_environment(options)
               db = ensure_database(options.merge(db: old_handle))
               db.update!(handle: new_handle)