jets 5.0.17 → 6.0.0.beta1

data/lib/jets/cli/release/history.rb

@@ -0,0 +1,68 @@
+require "date"
+require "tzinfo"
+
+class Jets::CLI::Release
+  class History < Base
+    rescue_api_error
+
+    def run
+      resp = Jets::Api::Stack.retrieve(:current)
+
+      name = "#{resp[:name]} #{resp[:location]}"
+      resp = Jets::Api::Release.list(@options)
+
+      data = resp[:data]
+      if data.empty?
+        log.info "No releases found for stack: #{name}"
+      else
+        log.info "Releases for stack: #{name}"
+        show_items(data)
+        paginate(resp)
+      end
+    end
+
+    def show_items(items)
+      presenter = CliFormat::Presenter.new(@options)
+      header = ["Version", "Status", "Released At", "Message"]
+      header << "Git Sha" if @options[:sha]
+      presenter.header = header
+      items.each do |item|
+        version = item[:version]
+        status = item[:stack_status]
+        released_at = item[:pretty_created_at] || item[:created_at]
+        message = item[:message] || "Deployed"
+        message = message[0..50]
+
+        row = [version, status, format_time(released_at), message]
+        if @options[:sha]
+          sha = item[:git_sha].to_s[0..7] if item[:git_sha]
+          row << sha
+        end
+        presenter.rows << row
+      end
+      presenter.show
+    end
+
+    def format_time(string)
+      if string.include?("ago") # IE: 5 minutes ago
+        string
+      else
+        utc = DateTime.parse(string)
+
+        tz_override = ENV["JETS_TZ"] # IE: America/Los_Angeles
+        local = if tz_override
+          tz = TZInfo::Timezone.get(tz_override)
+          tz.utc_to_local(utc)
+        else
+          utc.new_offset(DateTime.now.offset) # local time
+        end
+
+        if tz_override
+          local.strftime("%b %-d, %Y %-l:%M:%S%P")
+        else
+          local.strftime("%b %-d, %Y %H:%M:%S")
+        end
+      end
+    end
+  end
+end

data/lib/jets/cli/release/info.rb

@@ -0,0 +1,59 @@
+class Jets::CLI::Release
+  class Info < History
+    rescue_api_error
+
+    def run
+      release = get(@options[:version])
+
+      release_fields = %w[
+        version
+        status
+        created_at
+        message
+        deploy_user
+        jets_env
+        jets_extra
+        jets_version
+        jets_remote
+        ruby_version
+        region
+        docker_image
+        zip_location
+        git_branch
+        git_sha
+        git_url
+        git_message
+      ].map(&:to_sym)
+      data = release_fields.map do |field|
+        # special cases for values
+        value = if field == :created_at
+          time_string = release[:pretty_created_at] || release[:created_at]
+          format_time(time_string)
+        else
+          release[field]
+        end
+
+        label = field.to_s.titleize
+        [label, value]
+      end
+
+      release.endpoints.each do |endpoint|
+        name = endpoint[:name].titleize
+        data << [name, endpoint[:url]]
+      end
+
+      warn Jets.project.namespace.color(:green)
+      presenter = CliFormat::Presenter.new(@options)
+      presenter.empty_message = "Release not found for: #{Jets.project.namespace}"
+      data.each do |row|
+        presenter.rows << row
+      end
+      presenter.show
+    end
+
+    def get(version = nil)
+      version ||= "latest"
+      Jets::Api::Release.retrieve(version)
+    end
+  end
+end

data/lib/jets/cli/release/rollback.rb

@@ -0,0 +1,15 @@
+class Jets::CLI::Release
+  class Rollback < Base
+    rescue_api_error
+
+    def run
+      version = @options[:version]
+      resp = Info.new(@options).get(version)
+      unless resp[:version]
+        puts "ERROR: version #{version} not found".color(:red)
+        exit 1
+      end
+      Jets::Cfn::Rollback.new(@options).run
+    end
+  end
+end

data/lib/jets/cli/release.rb

@@ -0,0 +1,23 @@
+class Jets::CLI
+  class Release < Jets::Thor::Base
+    desc "history", "Release history"
+    paging_options(order: "desc", limit: 10)
+    def history
+      History.new(options).run
+    end
+    map list: :history
+
+    desc "info", "Release detailed information"
+    format_option(default: "info")
+    def info(version = nil)
+      Info.new(options.merge(version: version)).run
+    end
+    map show: :info
+
+    desc "rollback VERSION", "Rollback to a previous release", hide: true
+    option :yes, aliases: :y, type: :boolean, desc: "Skip are you sure prompt"
+    def rollback(version)
+      Rollback.new(options.merge(version: version)).run
+    end
+  end
+end

data/lib/jets/cli/schedule/base.rb

@@ -0,0 +1,5 @@
+class Jets::CLI::Schedule
+  class Base < Jets::CLI::Base
+    include Jets::Event::Dsl::RateExpression
+  end
+end

data/lib/jets/cli/schedule/translate.rb

@@ -0,0 +1,168 @@
+class Jets::CLI::Schedule
+  class Translate < Base
+    def run
+      are_you_sure?
+      check_exist!
+      success = perform
+      if success
+        finish_message
+      else
+        log.error "Translation failed."
+        exit 1
+      end
+    end
+
+    # interface method: used by deploy to translate on_deploy
+    def perform
+      # Currently only sidekiq is supported
+      sidekiq = YAML.load_file("config/sidekiq.yml")
+      sidekiq = ActiveSupport::HashWithIndifferentAccess.new(sidekiq)
+      schedule = sidekiq[:schedule]
+      unless schedule
+        log.error "config/sidekiq.yml does not have a schedule key. Nothing to translate."
+        return false
+      end
+
+      log.info "Translating config/sidekiq.yml => config/jets/schedule.yml"
+      mapped = schedule.map do |k, v|
+        translate_item(k, v)
+      end
+      schedule = mapped.inject({}) { |h, v| h.merge(v) }
+      text = schedule.deep_stringify_keys!
+
+      unless @@has_errors
+        FileUtils.mkdir_p("config/jets")
+        IO.write("config/jets/schedule.yml", YAML.dump(text))
+      end
+      !@@has_errors
+    end
+
+    JETS_FIELDS = %w[
+      args
+      class
+      cron
+      rate
+      splat_args
+    ]
+    SUPPORTED_FIELDS = JETS_FIELDS + %w[
+      keyword_arguments
+      every
+      interval
+    ]
+
+    # Example:
+    #   hard_worker:
+    #     class: "HardWorker"
+    #     args: ["bob", 5]
+    #     description: "This is a description of the job"
+    #     cron: "30 6 * *
+    def translate_item(key, original)
+      result = {}
+      result[:args] = original[:args] if original[:args]
+      result[:class] = original[:class] if original[:class]
+      result[:splat_args] = true if original[:keyword_arguments]
+      add_schedule_expression!(result, original)
+      unsupported_fields!(result, original)
+      {key => result}
+    end
+
+    def add_schedule_expression!(result, original)
+      if original[:cron]
+        result[:cron] = cron(original[:cron])
+      elsif original[:every]
+        handle_every_expression!(result, original[:every])
+      elsif original[:interval]
+        handle_every_expression!(result, original[:interval])
+      end
+    end
+
+    @@has_errors = false
+    def cron(expr)
+      parts = expr.split(" ")
+      # https://github.com/sidekiq-scheduler/sidekiq-scheduler
+      # Sidekiq scheduler has 6 fields. The first is for seconds. Cron does not support seconds.
+      # We'll remove the seconds first field.
+      if parts.size == 6
+        parts.shift
+      end
+      if parts.size != 5
+        log.info "ERROR: Unsupported cron expression. Too many fields."
+        log.info "There are #{parts.size} fields. Should have exactly 5 fields"
+        log.info "Offending cron expr: #{expr}"
+        @@has_errors = true
+      end
+      # AWS Cron expressions require ? for the day of the week field
+      parts[-1] = "?" if parts[-1] == "*"
+      if parts.size == 5
+        # AWS Cron expressions require a 6th year field
+        parts << "*"
+      end
+      parts.join(" ")
+    end
+
+    def handle_every_expression!(result, expr)
+      if simple_every?(expr)
+        result[:rate] = rate_expression(expr)
+      else
+        # complex every expression translate to cron
+        expr = Fugit::Nat.parse("every #{expr}").to_cron_s
+        result[:cron] = cron(expr)
+      end
+    end
+
+    def simple_every?(expr)
+      # IE: 1h, 1d, 1w, 1m, 45m, 45 minutes, 1 hour, 1 day, 1 week, 1 month
+      expr =~ /\d+\s?\w+/
+    end
+
+    def unsupported_fields!(result, original)
+      unsupported = original.keys - SUPPORTED_FIELDS
+      unsupported.each do |field|
+        result[:"unsupported_#{field}"] = original[field]
+      end
+      result
+    end
+
+    def check_exist!
+      unless File.exist?("config/sidekiq.yml")
+        abort "ERROR: config/sidekiq.yml does not exist. Unable to translate".color(:red)
+      end
+    end
+
+    def are_you_sure?
+      message = <<~EOL
+        This script will make changes to your project source code.
+
+        It will try to translate the schedule items in
+
+            config/sidekiq.yml => config/jets/schedule.yml
+
+        Note: It's unfeasible to account for all cases perform miracle translations.
+        It's a best-effort script, and the hope is that this script gets you pretty far
+        and is helpful. 😄
+
+        Please make sure you have backed up and committed your changes first.
+      EOL
+      sure?(message)
+    end
+
+    def finish_message
+      # Created message part of finish message because only want it to show as part of CLI run
+      log.info "\n    Created: config/jets/schedule.yml\n".color(:green)
+      log.info <<~EOL
+        Translation complete! Please double check the schedule to make sure it looks correct.
+        Remember, this is a best-effort tool. It does not cover all cases.
+
+        You can validate the config/jets/schedule.yml
+
+            jets schedule:validate
+
+        If that looks good, try deploying the config/jets/schedule.yml
+        It should create a *JetsScheduledEvent* child stack
+        with the schedule event rules.
+
+            jets deploy
+      EOL
+    end
+  end
+end

data/lib/jets/cli/schedule/validate.rb

@@ -0,0 +1,95 @@
+require "aws-sdk-cloudwatchevents"
+
+class Jets::CLI::Schedule
+  class Validate < Base
+    def run
+      are_you_sure?
+      check_exist!
+      valid = perform
+      if valid
+        log.info "Validation passed. config/jets/schedule.yml is valid"
+        if File.exist?("config/sidekiq.yml")
+          log.info <<~EOL
+            You can remove config/sidekiq.yml now. It is no longer needed.
+
+                rm config/sidekiq.yml
+          EOL
+        end
+      else
+        log.info "Validation failed.  Please fix the errors and try again."
+        log.info "Docs: https://docs.rubyonjets.com/docs/jobs/schedule/"
+        exit 1
+      end
+    end
+
+    # interface method: used by deploy to translate on_deploy
+    def perform
+      items = YAML.load_file("config/jets/schedule.yml")
+      items = ActiveSupport::HashWithIndifferentAccess.new(items)
+      items.each do |key, value|
+        validate_item(key, value)
+      end
+      !@@has_errors
+    end
+
+    def check_exist!
+      unless File.exist?("config/jets/schedule.yml")
+        abort "config/jets/schedule.yml does not exist. Nothing to validate."
+      end
+    end
+
+    @@rule_name = "validation_rule_#{Time.now.to_i}_#{rand(1000)}"
+    @@has_errors = false
+    def validate_item(key, value)
+      log.debug "To validate, creating live event rule for #{key}"
+      log.debug "value: #{value.inspect}"
+      schedule_expression = if value[:cron]
+        "cron(#{value[:cron]})"
+      elsif value[:rate]
+        expr = rate_expression(value[:rate])
+        "rate(#{expr})"
+      else
+        raise "No schedule expression found for: #{key}"
+      end
+
+      # Create the rule with the provided cron expression
+      client.put_rule(
+        name: @@rule_name,
+        schedule_expression: schedule_expression,
+        state: "DISABLED" # Disable the rule to prevent it from being triggered
+      )
+
+      # log.info "Valid rule: #{key}"
+      # log.info "  Schedule expression: #{schedule_expression}"
+      true # If no error is raised, the cron expression is valid
+    rescue Aws::CloudWatchEvents::Errors::ValidationException => e
+      log.error "Invalid rule: #{key}"
+      log.error "Schedule expression: #{schedule_expression}"
+      # log.error "Validation Error: #{e.message}" # commented out to reduce noise, not useful
+      @@has_errors ||= true
+      false # If ValidationException is raised, the cron expression is invalid
+    ensure
+      # Delete the rule after validation (whether it's valid or not)
+      begin
+        client.delete_rule(name: @@rule_name)
+      rescue
+        nil
+      end
+    end
+
+    def are_you_sure?
+      message = <<~EOL
+        Will validate: config/jets/schedule.yml
+
+        It does this by creating a live test event rule for each entry in schedule.yml
+        and then deleting it.
+      EOL
+      sure?(message)
+    end
+
+    def client
+      Aws::CloudWatchEvents::Client.new
+    end
+    memoize :client
+  end
+end

data/lib/jets/cli/schedule.rb

@@ -0,0 +1,15 @@
+class Jets::CLI
+  class Schedule < Jets::Thor::Base
+    desc "translate", "Translate Sidekiq Schedule to Jets"
+    yes_option
+    def translate
+      Translate.new(options).run
+    end
+
+    desc "validate", "Validate config/jets/schedule.yml"
+    yes_option
+    def validate
+      Validate.new(options).run
+    end
+  end
+end

data/lib/jets/cli/stacks.rb

@@ -0,0 +1,33 @@
+class Jets::CLI
+  class Stacks < Base
+    rescue_api_error
+
+    def run
+      params = paging_params.merge(options)
+      resp = Jets::Api::Stack.list(params)
+      log.info stacks_for_message
+      present(resp[:data])
+      paginate(resp)
+    end
+
+    private
+
+    def stacks_for_message
+      if options[:all_projects]
+        "Stacks for all projects:"
+      else
+        "Stacks for project: #{Jets.project.name}"
+      end
+    end
+
+    def present(items)
+      presenter = CliFormat::Presenter.new(@options)
+      presenter.empty_message = "No stacks found"
+      items.each do |item|
+        row = "#{item[:name]} #{item[:location]}"
+        presenter.rows << [row]
+      end
+      presenter.show
+    end
+  end
+end

data/lib/jets/cli/stop.rb

@@ -0,0 +1,31 @@
+class Jets::CLI
+  class Stop < Jets::CLI::Ci::Base
+    def run
+      are_you_sure?
+      check_build_id!
+      run_with_exception_handling do
+        stopped = stop_build
+        if stopped
+          log.info <<~EOL
+            Deploy has been stopped: #{build_id}
+            Note: If the deploy has already started the CloudFormation update,
+            it will continue. Please check the logs.
+
+          EOL
+          show_console_log_url(build_id)
+        end
+      end
+    end
+
+    def stack_name
+      "#{Jets.project.namespace}-remote"
+    end
+    alias_method :project_name, :stack_name
+
+    def are_you_sure?
+      unless @options[:yes]
+        sure? "Will attempt to stop the deploy for project #{project_name.color(:green)} build_id #{build_id.color(:green)}"
+      end
+    end
+  end
+end

data/lib/jets/cli/teardown.rb

@@ -0,0 +1,8 @@
+class Jets::CLI
+  class Teardown < Base
+    def run
+      sure?("Will teardown the stack #{Jets.project.namespace}")
+      Jets::Cfn::Teardown.new(@options).run
+    end
+  end
+end

data/lib/jets/cli/tip.rb

@@ -0,0 +1,86 @@
+class Jets::CLI
+  class Tip
+    class << self
+      def show(name, options = {})
+        new(name).show(options)
+      end
+    end
+
+    delegate :config, to: "Jets.project"
+
+    def initialize(name)
+      @name = name
+    end
+
+    def show(options = {})
+      return if already_configured?
+      return unless enabled?
+      puts send(@name)
+      puts disable_howto unless options[:disable_howto] == false
+    end
+
+    def already_configured?
+      if @name == :faster_deploy
+        config = Jets.bootstrap.config
+        config.codebuild.project.env.vars.key?(:DOCKER_HOST) ||
+          config.codebuild.fleet.enable ||
+          config.codebuild.fleet_override
+      else
+        false
+      end
+    end
+
+    def faster_deploy
+      <<~EOL
+        Tip: You can speed the deploy with one of these options:
+
+        * Docker Remote Host: https://docs.rubyonjets.com/docs/remote/codebuild/docker/
+        * CodeBuild Fleet: https://docs.rubyonjets.com/docs/remote/codebuild/fleet/
+
+        Enabling of those options will also remove this message.
+      EOL
+    end
+
+    def concurrency_change
+      <<~EOL
+
+        Note: CLI changes to concurrency are outside of deployment
+      EOL
+    end
+
+    def env_change
+      <<~EOL
+
+        Note: CLI changes to env vars are outside of deployment
+        See: https://docs.rubyonjets.com/env/cli/
+      EOL
+    end
+
+    def ssm_change
+      <<~EOL
+        After deleting a parameter, wait for at least 30 seconds
+        to create a parameter with the same name
+      EOL
+    end
+
+    def disable_howto
+      <<~EOL
+        To disable this tip:
+
+        * set config.tips.#{@name} = false in config/jets/project.rb
+        * See: https://docs.rubyonjets.com/docs/more/cli-tips/
+      EOL
+    end
+
+    def remote_run
+      <<~EOL
+        Ctrl-C will stop showing logs. Jets will continue to run remotely.
+        If you want to stop the remote process, use: jets stop
+      EOL
+    end
+
+    def enabled?
+      config.tips.enable && config.tips[@name]
+    end
+  end
+end

data/lib/jets/cli/url.rb

@@ -0,0 +1,41 @@
+require "cli-format"
+
+class Jets::CLI
+  class Url < Base
+    rescue_api_error
+
+    def run
+      if @options[:format] == "json"
+        puts data.to_json # simpler json format allows for: jets url | jq
+      else
+        present(data)
+      end
+    end
+
+    private
+
+    def present(items)
+      presenter = CliFormat::Presenter.new(@options)
+      presenter.empty_message = "No url info found"
+      presenter.header = ["Name", "Value"] if @options[:header] # default: false
+      data.keys.sort.each do |name|
+        next if name.to_s == "queue_url" # dont show Queue Url
+        name_url = name.to_s.titleize
+        value = data[name]
+        row = [name_url, value]
+        presenter.rows << row
+      end
+      presenter.show
+    end
+
+    def data
+      release = Release::Info.new(@options).get
+      data = release.endpoints.inject({}) do |acc, endpoint|
+        acc.merge!(endpoint[:name] => endpoint[:url])
+      end
+      data.delete_if { |k, v| v.nil? } # remove nil values
+      data
+    end
+    memoize :data
+  end
+end

data/lib/jets/cli/waf/base.rb

@@ -0,0 +1,7 @@
+class Jets::CLI::Waf
+  class Base < Jets::CLI::Base
+    def stack_name
+      [Jets::CLI::Waf.waf_name, "waf"].compact.join("-")
+    end
+  end
+end

data/lib/jets/cli/waf/build.rb

@@ -0,0 +1,8 @@
+class Jets::CLI::Waf
+  class Build < Base
+    def run
+      Jets::Cfn::Bootstrap.new(@options).run
+      Jets::Remote::Runner.new(@options.merge(command: "waf:build")).run
+    end
+  end
+end

data/lib/jets/cli/waf/delete.rb

@@ -0,0 +1,17 @@
+class Jets::CLI::Waf
+  class Delete < Base
+    def run
+      are_you_sure?
+      Jets::Cfn::Bootstrap.new(@options).run
+      Jets::Remote::Runner.new(@options.merge(command: "waf:delete")).run
+    end
+
+    private
+
+    def are_you_sure?
+      unless @options[:yes]
+        sure?("Will delete #{stack_name.color(:green)} in us-east-1")
+      end
+    end
+  end
+end