jets 3.1.0 → 5.0.0

data/lib/jets/commands/{deploy.rb → deploy/deploy_command.rb}

@@ -1,41 +1,39 @@
-require "aws-sdk-core"
-
-module Jets::Commands
-  class Deploy
-    extend Memoist
-    include StackInfo
-    def initialize(options)
-      @options = options
-    end
-
-    def run
-      deployment_env = Jets.config.project_namespace.color(:green)
-      puts "Deploying to Lambda #{deployment_env} environment..."
+module Jets::Command
+  class DeployCommand < Base # :nodoc:
+    include EnvironmentArgument
+
+    desc "deploy", "Builds and deploys project to AWS Lambda"
+    long_desc Help.text(:deploy)
+    option :message, aliases: :m, desc: "Custom message to use for the deployment message"
+    def perform
+      extract_environment_option_from_argument
+      require_application_and_environment!
+
+      stack = Jets.project_namespace.color(:green)
+      puts "Deploying stack #{stack} ..."
       return if @options[:noop]
 
       check_dev_mode
       validate_routes!
 
-      # deploy full nested stack when stack already exists
       # Delete existing rollback stack from previous bad minimal deploy
       delete_minimal_stack if minimal_rollback_complete?
       exit_unless_updateable! # Stack could be in a weird rollback state or in progress state
 
       if first_run?
         ship(stack_type: :minimal)
-        Jets.application.reload_configs!
       end
 
-      # Build code after the minimal stack because need s3 bucket for assets
-      # on_aws? and s3_base_url logic
+      # Build code after the minimal stack because need s3 bucket for assets on_aws? and s3_base_url logic
       # TODO: possible deploy hook point: before_build
-      build_code
+      Jets::Builders::CodeBuilder.new.build
 
       # TODO: possible deploy hook point: before_ship
       create_s3_event_buckets
-      ship(stack_type: :full, s3_bucket: s3_bucket)
+      ship(stack_type: :full, s3_bucket: Jets.s3_bucket)
     end
 
+  private
     def create_s3_event_buckets
       buckets = Jets::Job::Base.s3_events.keys
       buckets.each do |bucket|
@@ -51,37 +49,32 @@ module Jets::Commands
     end
 
     def check_dev_mode
-      if File.exist?("#{Jets.root}/dev.mode")
+      if File.exist?("#{Jets.root}/dev.mode") && !ENV['JETS_SKIP_DEV_MODE_CHECK']
         puts "The dev.mode file exists. Please removed it and run bundle update before you deploy.".color(:red)
         exit 1
       end
     end
 
-    def build_code
-      Jets::Commands::Build.new(@options).build_code
-    end
-
     def validate_routes!
       valid = Jets::Router.validate_routes!
-      unless valid
-        puts "Deploy fail: The jets application contain invalid routes.".color(:red)
-        exit 1
-      end
+      return if valid
+
+      puts "Deploy fail: The jets application contain invalid routes.".color(:red)
+      exit 1
     end
 
     def ship(stack_options)
-      options = @options.merge(stack_options) # includes stack_type and s3_bucket
-      Jets::Commands::Build.new(options).build_templates
+      options = @options.merge(stack_options) # includes stack_type
+      Jets::Cfn::Builder.new(options).build
       Jets::Cfn::Ship.new(options).run
     end
 
     def status
-      Jets::Cfn::Status.new(stack_name)
+      @status ||= Jets::Cfn::Status.new(stack_name)
     end
-    memoize :status
 
     def stack_name
-      Jets::Naming.parent_stack_name
+      Jets::Names.parent_stack_name
     end
 
     # Checks for a few things before deciding to delete the parent stack
@@ -101,37 +94,25 @@ module Jets::Commands
       resource_statuses == ['DELETE_COMPLETE']
     end
 
-    def find_stack(stack_name)
-      resp = cfn.describe_stacks(stack_name: stack_name)
-      resp.stacks.first
-    rescue Aws::CloudFormation::Errors::ValidationError => e
-      # example: Stack with id demo-dev does not exist
-      if e.message =~ /Stack with/ && e.message =~ /does not exist/
-        nil
-      else
-        raise
-      end
-    end
-
     # All CloudFormation states listed here: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html
     def exit_unless_updateable!
       return if ENV['JETS_FORCE_UPDATEABLE'] # useful for debugging if stack stack updating
 
-      stack_name = Jets::Naming.parent_stack_name
+      stack_name = Jets::Names.parent_stack_name
       exists = stack_exists?(stack_name)
       return unless exists # continue because stack could be updating
 
       stack = cfn.describe_stacks(stack_name: stack_name).stacks.first
       status = stack["stack_status"]
       if status =~ /^ROLLBACK_/ ||
-         status =~ /_IN_PROGRESS$/
+          status =~ /_IN_PROGRESS$/
         region = `aws configure get region`.strip rescue "us-east-1"
         url = "https://console.aws.amazon.com/cloudformation/home?region=#{region}#/stacks"
-        puts "The parent stack of the #{Jets.config.project_name.color(:green)} project is not in an updateable state."
+        puts "The parent stack of the #{Jets.project_name.color(:green)} project is not in an updateable state."
         puts "Stack name #{stack_name.color(:yellow)} status #{stack["stack_status"].color(:yellow)}"
         puts "Here's the CloudFormation url to check for more details #{url}"
         exit 1
       end
     end
-  end
+    end
 end

data/lib/jets/commands/dev/dev_command.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "jets/dev_caching"
+
+module Jets
+  module Command
+    class DevCommand < Base # :nodoc:
+      no_commands do
+        def help
+          say "jets dev:cache # Toggle development mode caching on/off."
+        end
+      end
+
+      def cache
+        Jets::DevCaching.enable_by_file
+      end
+    end
+  end
+end

data/lib/jets/commands/{dotenv.rb → dotenv/dotenv_command.rb}

@@ -1,5 +1,5 @@
-module Jets::Commands
-  class Dotenv < Jets::Commands::Base
+module Jets::Command
+  class DotenvCommand < Base # :nodoc:
     desc "show", "Shows evaulated dotenv values"
     long_desc Help.text('dotenv:show')
     def show

data/lib/jets/commands/encrypted/USAGE

@@ -0,0 +1,46 @@
+## Storing Encrypted Files in Source Control
+
+The Jets `encrypted` commands provide access to encrypted files or configurations.
+See the `Jets.application.encrypted` documentation for using them in your app.
+
+This is a more generalized concept of `jets credentials`.
+
+## Encryption Keys
+
+By default, Jets looks for the encryption key in `config/master.key` or
+`ENV["JETS_MASTER_KEY"]`, but that lookup can be overridden with `--key`:
+
+    jets encrypted:edit config/encrypted_file.yml.enc --key config/encrypted_file.key
+
+Don't commit the key! Add it to your source control's ignore file. If you use
+Git, Jets handles this for you.
+
+## Editing Files
+
+To edit or create an encrypted file use:
+
+    jets encrypted:edit config/encrypted_file.yml.enc
+
+This opens a temporary file in `$EDITOR` with the decrypted contents for editing.
+
+## Viewing Files
+
+To print the decrypted contents of an encrypted file use:
+
+    jets encrypted:show config/encrypted_file.yml.enc
+
+## Access in App
+
+Let's say you have encrypted like so:
+
+    ❯ jets encrypted:show config/encrypted_file.yml.enc
+    cloud:
+      foo: bar
+
+You can access them in the app like so:
+
+    $ jets console
+    > file = ActiveSupport::EncryptedFile.new(content_path: "./config/encrypted_file.yml.enc", key_path: "./config/master.key", env_key: Jets.env, raise_if_missing_key: true)
+    > YAML.load(file.read)
+    => {"cloud"=>{"foo"=>"bar"}}
+    >

data/lib/jets/commands/encrypted/encrypted_command.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "active_support"
+require "jets/command/helpers/editor"
+
+module Jets
+  module Command
+    class EncryptedCommand < Jets::Command::Base # :nodoc:
+      include Helpers::Editor
+
+      class_option :key, aliases: "-k", type: :string,
+        default: "config/master.key", desc: "The Jets.root relative path to the encryption key"
+
+      no_commands do
+        def help
+          say "Usage:\n  #{self.class.banner}"
+          say ""
+          say self.class.desc
+        end
+      end
+
+      def edit(file_path)
+        require_application!
+        encrypted = Jets.application.encrypted(file_path, key_path: options[:key])
+
+        ensure_editor_available(command: "bin/jets encrypted:edit") || (return)
+        ensure_encryption_key_has_been_added(options[:key]) if encrypted.key.nil?
+        ensure_encrypted_file_has_been_added(file_path, options[:key])
+
+        catch_editing_exceptions do
+          change_encrypted_file_in_system_editor(file_path, options[:key])
+        end
+
+        say "File encrypted and saved."
+      rescue ActiveSupport::MessageEncryptor::InvalidMessage
+        say "Couldn't decrypt #{file_path}. Perhaps you passed the wrong key?"
+      end
+
+      def show(file_path)
+        require_application!
+        encrypted = Jets.application.encrypted(file_path, key_path: options[:key])
+
+        say encrypted.read.presence || missing_encrypted_message(key: encrypted.key, key_path: options[:key], file_path: file_path)
+      end
+
+      private
+        def ensure_encryption_key_has_been_added(key_path)
+          encryption_key_file_generator.add_key_file(key_path)
+          encryption_key_file_generator.ignore_key_file(key_path)
+        end
+
+        def ensure_encrypted_file_has_been_added(file_path, key_path)
+          encrypted_file_generator.add_encrypted_file_silently(file_path, key_path)
+        end
+
+        def change_encrypted_file_in_system_editor(file_path, key_path)
+          Jets.application.encrypted(file_path, key_path: key_path).change do |tmp_path|
+            system("#{ENV["EDITOR"]} #{tmp_path}")
+          end
+        end
+
+
+        def encryption_key_file_generator
+          require "rails/generators"
+          require "rails/generators/rails/encryption_key_file/encryption_key_file_generator"
+
+          Rails::Generators::EncryptionKeyFileGenerator.new
+        end
+
+        def encrypted_file_generator
+          require "rails/generators"
+          require "rails/generators/rails/encrypted_file/encrypted_file_generator"
+
+          Rails::Generators::EncryptedFileGenerator.new
+        end
+
+        def missing_encrypted_message(key:, key_path:, file_path:)
+          if key.nil?
+            "Missing '#{key_path}' to decrypt data. See `bin/jets encrypted:help`"
+          else
+            "File '#{file_path}' does not exist. Use `bin/jets encrypted:edit #{file_path}` to change that."
+          end
+        end
+    end
+  end
+end

data/lib/jets/commands/gems/gems_command.rb

@@ -0,0 +1,14 @@
+module Jets::Command
+  class GemsCommand < Base
+    desc "check", "Check if precompiled Lambda gems are available"
+    long_desc Help.text("gems:check")
+    option :verbose, type: :boolean, desc: "Verbose mode"
+    def check
+      Jets.boot
+      check = Jets::Api::Gems::Check.new(@options)
+      check.run! # exits early if missing gems found
+      # If reach here, means all gems are ok.
+      puts "Congrats! All gems are available in as precompiled Lambda gems 👍"
+    end
+  end
+end

data/lib/jets/commands/generate/generate_command.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Jets::Command
+  class GenerateCommand < Base # :nodoc:
+    no_commands do
+      # jets generate -h
+      # Note: Other help flags like jets generate scaffold -h will be handled by
+      # invoking the generator and letting it handle the help flag.
+      def help
+        require_application_and_environment!
+        load_generators
+        all_commands_help self.class.command_name
+      end
+    end
+
+    desc "Generate", "Generate code"
+    long_desc Help.text(:generate)
+    def perform(*)
+      # require lazily so that Rails constant is only defined within generators
+      require "jets/generators"
+
+      generator = args.shift
+      return help unless generator
+
+      require_application_and_environment!
+      load_generators # engine.rb load_generators => Jets.application.load_generators
+
+      ARGV.replace(args) # set up ARGV for third-party libraries
+
+      Jets::Generators.invoke generator, args, behavior: behavior, destination_root: Jets::Command.root
+    end
+
+  private
+    def behavior
+      :invoke
+    end
+
+    def all_commands_help(command = "generate")
+      puts "Usage: jets #{command} GENERATOR [args] [options]"
+      puts
+      puts "General options:"
+      puts "  -h, [--help]     # Print generator's options and usage"
+      puts "  -p, [--pretend]  # Run but do not make any changes"
+      puts "  -f, [--force]    # Overwrite files that already exist"
+      puts "  -s, [--skip]     # Skip files that already exist"
+      puts "  -q, [--quiet]    # Suppress status output"
+      puts
+      puts "Please choose a generator below."
+      puts
+
+      Rails::Generators.print_generators
+    end
+  end
+end
+
+# Decorate the Group#help method to replace rails with jets.
+#
+# Note: Initially tried only decorating when a help flag like `-h` is detected
+# but some commands will trigger help output without the flag.  For example:
+#   jets generate job
+# The command requires a name
+#   jets generate job NAME
+#
+# The underlying Rails::Generators.invoke does this
+#   if klass = find_by_namespace(names.pop, names.any? && names.join(":"))
+#     args << "--help" if args.empty? && klass.arguments.any?(&:required?)
+# and is able to detect that the name is missing and triggers the help output.
+#
+# Jets does not have this logic yet.  So we'll decorate the help method to
+# at the Thor::Group#help level.
+require "thor"
+class Thor::Group
+  module ReplaceHelpOutputWithJets
+    def help(shell)
+      out = capture_stdout_for_help do
+        super # invoke to get the help output
+      end
+      puts out.gsub('rails','jets').gsub('Rails','Jets')
+    end
+
+    def capture_stdout_for_help
+      stdout_old = $stdout
+      io = StringIO.new
+      $stdout = io
+      yield
+      $stdout = stdout_old
+      io.string
+    end
+  end
+
+  class << self
+    # The help method is defined in the Thor::Group class.  We are decorating it
+    prepend ReplaceHelpOutputWithJets
+  end
+end

data/lib/jets/commands/help/USAGE

@@ -0,0 +1,20 @@
+Common Jets commands:
+  generate     Generate new code (short-cut alias: "g")
+  console      Start the Jets console (short-cut alias: "c")
+  server       Start the Jets server (short-cut alias: "s")
+  deploy       Deploy application to Lambda
+  logs         View Lambda function logs
+<% unless engine? -%>
+  new          Create a new Jets application. "jets new demo" creates a
+               new application called Demo in "./demo"
+<% end -%>
+
+Jets Pro commands:
+  projects     List projects
+  stacks       List stacks
+  releases     List releases
+  rollback     Rollback to a previous release
+
+All commands can be run with -h (or --help) for more information.
+In addition to those commands, there are:
+

data/lib/jets/commands/help/help_command.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Jets
+  module Command
+    class HelpCommand < Base # :nodoc:
+      hide_command!
+
+      def help(*)
+        say self.class.desc
+
+        Jets::Command.print_commands
+      end
+    end
+  end
+end

data/lib/jets/commands/initializers/initializers_command.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Jets
+  module Command
+    class InitializersCommand < Base # :nodoc:
+      include EnvironmentArgument
+
+      desc "initializers", "Print out all defined initializers in the order they are invoked by Jets."
+      def perform
+        extract_environment_option_from_argument
+        require_application_and_environment!
+
+        Jets.application.initializers.tsort_each do |initializer|
+          say "#{initializer.context_class}.#{initializer.name}"
+        end
+      end
+    end
+  end
+end

data/lib/jets/commands/logs/logs_command.rb

@@ -0,0 +1,45 @@
+require "aws-logs"
+
+module Jets::Command
+  class LogsCommand < Base # :nodoc:
+    include Jets::AwsServices
+
+    option :since, desc: "From what time to begin displaying logs.  By default, logs will be displayed starting from 10m in the past. The value provided can be an ISO 8601 timestamp or a relative time. Examples: 10m 2d 2w"
+    option :follow, aliases: :f, default: false, type: :boolean, desc: " Whether to continuously poll for new logs. To exit from this mode, use Control-C."
+    option :format, default: "simple", desc: "The format to display the logs. IE: detailed or short.  With detailed, the log stream name is also shown."
+    option :filter_pattern, desc: "The filter pattern to use. If not provided, all the events are matched"
+    option :log_group_name, aliases: :n, desc: "The log group name.  By default, it is /aws/lambda/#{Jets.project_namespace}-controller"
+    option :refresh_rate, default: 1, type: :numeric, desc: "How often to refresh the logs in seconds."
+    option :wait_exists, default: true, type: :boolean, desc: "Whether to wait until the log group exists.  By default, it will wait."
+    long_desc Help.text(:logs)
+    def perform
+      show_logs
+    end
+
+  private
+    def show_logs
+      options = @options.dup # so it can be modified
+      options[:log_group_name] = log_group_name
+      options[:since] ||= "10m" # by default, start search 10m in the past
+      options[:wait_exists_retries] = 12 # 12 * 5 = 60 seconds
+
+      verb = options[:follow] ? "Tailing" : "Showing"
+      $stderr.puts "#{verb} logs for #{options[:log_group_name]}"
+
+      tail = AwsLogs::Tail.new(options)
+      tail.run
+    end
+
+    def log_group_name
+      default = "/aws/lambda/#{Jets.project_namespace}-controller"
+      return default unless @options[:log_group_name]
+
+      if @options[:log_group_name].include?("aws/lambda") || @options[:log_group_name].include?(Jets.project_namespace)
+        @options[:log_group_name]
+      else
+        # IE: hard_job-dig => /aws/lambda/demo-dev-hard_job-dig
+        "/aws/lambda/#{Jets.project_namespace}-#{@options[:log_group_name]}"
+      end
+    end
+  end
+end

data/lib/jets/commands/new/new_command.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Jets
+  module Command
+    class NewCommand < Base # :nodoc:
+      no_commands do
+        def help
+          Jets::Command.invoke :application, [ "--help" ]
+        end
+      end
+
+      def perform(*)
+        say "Can't initialize a new Jets application within the directory of another, please change to a non-Jets directory first.\n"
+        say "Type 'jets' for help."
+        exit 1
+      end
+    end
+  end
+end

data/lib/jets/commands/notes/notes_command.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Jets
+  module Command
+    class NotesCommand < Base # :nodoc:
+      class_option :annotations, aliases: "-a", desc: "Filter by specific annotations, e.g. Foobar TODO", type: :array
+
+      def perform(*)
+        require_application_and_environment!
+
+        # lazy require so Rails const is only defined when using notes
+        require "rails/source_annotation_extractor"
+
+        display_annotations
+      end
+
+      private
+        def display_annotations
+          annotations = options[:annotations] || Rails::SourceAnnotationExtractor::Annotation.tags
+          tag = (annotations.length > 1)
+
+          Rails::SourceAnnotationExtractor.enumerate annotations.join("|"), tag: tag, dirs: directories
+        end
+
+        def directories
+          Rails::SourceAnnotationExtractor::Annotation.directories
+        end
+    end
+  end
+end

data/lib/jets/commands/plugin/plugin_command.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Jets
+  module Command
+    class PluginCommand < Base # :nodoc:
+      hide_command!
+
+      def help
+        run_plugin_generator %w( --help )
+      end
+
+      def self.banner(*) # :nodoc:
+        "#{executable} new [options]"
+      end
+
+      class_option :rc, type: :string, default: File.join("~", ".jetsrc"),
+        desc: "Initialize the plugin command with previous defaults. Uses .jetsrc in your home directory by default."
+
+      class_option :no_rc, desc: "Skip evaluating .jetsrc."
+
+      def perform(type = nil, *plugin_args)
+        plugin_args << "--help" unless type == "new"
+
+        unless options.key?("no_rc") # Thor's not so indifferent access hash.
+          jetsrc = File.expand_path(options[:rc])
+
+          if File.exist?(jetsrc)
+            extra_args = File.read(jetsrc).split(/\n+/).flat_map(&:split)
+            say "Using #{extra_args.join(" ")} from #{jetsrc}"
+            plugin_args.insert(1, *extra_args)
+          end
+        end
+
+        run_plugin_generator plugin_args
+      end
+
+      private
+        def run_plugin_generator(plugin_args)
+          require "jets/generators"
+          require "jets/generators/jets/plugin/plugin_generator"
+          Jets::Generators::PluginGenerator.start plugin_args
+        end
+    end
+  end
+end

data/lib/jets/commands/projects/projects_command.rb

@@ -0,0 +1,30 @@
+module Jets::Command
+  class ProjectsCommand < Base # :nodoc:
+    desc "projects", "List deployed projects"
+    long_desc Help.text(:projects)
+    paging_options.call
+    def perform
+      no_token_exit!
+      resp = Jets::Api::Project.list(paging_params)
+      check_for_error_message!(resp)
+
+      data = resp["data"]
+      if data.empty?
+        $stderr.puts "No projects deployed yet."
+      else
+        show_items(data)
+      end
+    rescue Jets::Api::RequestError => e
+      puts "WARNING: Unable to list projects. #{e.class}: #{e.message}"
+    end
+
+  private
+    def show_items(items)
+      presenter = CliFormat::Presenter.new
+      presenter.header = ["Name"]
+      items.each do |item|
+        puts item["name"]
+      end
+    end
+  end
+end