jets 5.0.14 → 6.0.0.beta1

data/lib/jets/{generators/job → cli/generate}/templates/event_types/log.rb.tt

@@ -1,9 +1,7 @@
-<% module_namespacing do -%>
-class <%= class_name %>Job < ApplicationJob
+class <%= class_name %>Event < ApplicationEvent
   log_event "/aws/lambda/hello"
-  def <%= options[:name] %>
+  def <%= options[:method] %>
     puts "event #{JSON.dump(event)}"
     puts "log_event #{JSON.dump(log_event)}"
   end
 end
-<% end -%>

data/lib/jets/{generators/job → cli/generate}/templates/event_types/rule.rb.tt

@@ -1,5 +1,4 @@
-<% module_namespacing do -%>
-class <%= class_name %>Job < ApplicationJob
+class <%= class_name %>Event < ApplicationEvent
   rule_event(
     description: "Checks for security group changes",
     detail_type: ["AWS API Call via CloudTrail"],
@@ -15,9 +14,8 @@ class <%= class_name %>Job < ApplicationJob
       ]
     }
   )
-  def <%= options[:name] %>
+  def <%= options[:method] %>
     puts "event: #{JSON.dump(event)}" # event is available
     # your logic
   end
 end
-<% end -%>

data/lib/jets/cli/generate/templates/event_types/s3.rb.tt

@@ -0,0 +1,13 @@
+class <%= class_name %>Event < ApplicationEvent
+  # Please read the Considerations section before using s3_event
+  s3_event "my-bucket" # <= CHANGE ME: new or existing bucket
+  def <%= options[:method] %>
+    puts "event #{JSON.dump(event)}"
+    puts "s3_events #{JSON.dump(s3_events)}"
+    puts "s3_objects #{JSON.dump(s3_objects)}"
+    # s3_files.each do |file|
+    #   puts "file.filename #{file.filename}"
+    #   puts "file.content #{file.content}"
+    # end
+  end
+end

data/lib/jets/cli/generate/templates/event_types/scheduled.rb.tt

@@ -0,0 +1,6 @@
+class <%= class_name %>Event < ApplicationEvent
+  rate "10 hours"
+  def <%= options[:method] %>
+    puts "Do something with event #{JSON.dump(event)}"
+  end
+end

data/lib/jets/cli/generate/templates/event_types/sns.rb.tt

@@ -0,0 +1,8 @@
+class <%= class_name %>Event < ApplicationEvent
+  sns_event "hello-topic"
+  def <%= options[:method] %>
+    puts "event #{JSON.dump(event)}"
+    puts "sns_events #{JSON.dump(sns_events)}"
+    puts "sns_events? #{JSON.dump(sns_events?)}"
+  end
+end

data/lib/jets/cli/generate/templates/event_types/sqs.rb.tt

@@ -0,0 +1,9 @@
+class <%= class_name %>Event < ApplicationEvent
+  class_timeout 30 # Lambda Function timeout must be less than or equal to the SQS Visibility timeout
+  sqs_event "hello-queue"
+  def <%= options[:method] %>
+    puts "event #{JSON.dump(event)}"
+    puts "sqs_events #{JSON.dump(sqs_events)}"
+    puts "sqs_events? #{JSON.dump(sqs_events?)}"
+  end
+end

data/lib/jets/cli/generate.rb

@@ -0,0 +1,6 @@
+class Jets::CLI
+  class Generate < Jets::Thor::Base
+    Event.cli_options.each { |args| option(*args) }
+    register(Event, "event", "event NAME", "Generate event app code")
+  end
+end

data/lib/jets/cli/group/actions.rb

@@ -0,0 +1,57 @@
+module Jets::CLI::Group
+  module Actions
+    extend Memoist
+
+    def config_environment(data, options = {})
+      config_file = if options[:env]
+        "config/environments/#{options[:env]}.rb"
+      else
+        "config/application.rb"
+      end
+      lines = IO.readlines(config_file)
+      # remove comment lines
+      lines.reject! { |line| line =~ /^\s*#/ }
+      found = lines.any? { |line| line.include?(data) }
+      environment(data, options) unless found
+    end
+
+    def environment(data = nil, options = {})
+      sentinel = "class Application < Rails::Application\n"
+      env_file_sentinel = "Rails.application.configure do\n"
+      data ||= yield if block_given?
+
+      in_root do
+        if options[:env].nil?
+          inject_into_file "config/application.rb", optimize_indentation(data, 4), after: sentinel, verbose: true
+        else
+          Array(options[:env]).each do |env|
+            inject_into_file "config/environments/#{env}.rb", optimize_indentation(data, 2), after: env_file_sentinel, verbose: true
+          end
+        end
+      end
+    end
+    alias_method :application, :environment
+
+    def optimize_indentation(value, amount = 0) # :doc:
+      return "#{value}\n" unless value.is_a?(String)
+      "#{value.strip_heredoc.indent(amount).chomp}\n"
+    end
+    alias_method :rebase_indentation, :optimize_indentation
+
+    def comment_out_line(string, options = {})
+      file = if options[:env]
+        "config/environments/#{options[:env]}.rb"
+      else
+        "config/application.rb"
+      end
+      lines = IO.readlines(file).map do |l|
+        if l.include?(string) && !l.strip.start_with?("#")
+          "  # #{l.strip}"
+        else
+          l
+        end
+      end
+      IO.write(file, lines.join)
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+require "fileutils"
+require "thor"
+
+module Jets::CLI::Group
+  class Base < Thor::Group
+    include Thor::Actions
+    include Actions
+    include Helpers
+
+    add_runtime_options! # force, pretend, quiet, skip options
+  end
+end

data/lib/jets/cli/group/helpers.rb

@@ -0,0 +1,26 @@
+module Jets::CLI::Group
+  module Helpers
+    extend Memoist
+
+    def class_name
+      name.camelize
+    end
+
+    def underscore_name
+      name.underscore
+    end
+
+    def init_project_name
+      Jets.project.name # inferred from the folder name
+    end
+
+    def framework
+      Jets::CLI::Init::Detect.new.framework
+    end
+    memoize :framework
+
+    def package_type
+      (framework == "rails") ? "image" : "zip"
+    end
+  end
+end

data/lib/jets/cli/help/build.md

@@ -0,0 +1 @@
+Build the package and CloudFormation templates but does not deploy it. This can be helpful for development.

data/lib/jets/cli/help/call.md

@@ -0,0 +1,28 @@
+## Remote mode
+
+Invoke the lambda function on AWS.
+
+## Examples Cheatsheet
+
+    jets call -n cool_event-party -e '{"test":1}'
+    jets call -n cool_event-party -e '{"test":1}' | jq .
+    jets call -n cool_event-party -e '{"test":1}' --verbose | jq
+    jets call -n cool_event-party file://event.json | jq . # load event with a file
+    jets call -n jets-prewarm_event-handle -e '{"invocation_type": "RequestResponse"}'
+
+The equivalent AWS Lambda CLI command:
+
+    aws lambda invoke --function-name demo-dev-cool_event-party --payload -e '{"test":1}' outfile.txt
+    cat outfile.txt | jq '.'
+
+## Logs
+
+The `jets call` command can also print out the last 4KB of the lambda logs with the `--verbose` option. The logging output is directed to stderr and the response output from the lambda function itself is directed to stdout so you can safely pipe the results of the call command to other tools like `jq`.
+
+## Controller Note
+
+You can directly call a controller but you must provide it with a event payload that it understands. IE: The event payload needs to come from Lambda Fucntion URL, APIGW, or ALB.
+
+    jets call -n controller --event file://lambda.json
+
+The `jets curl` handles this more automatically is recommended over the `jets call` command for calling Jets controller.

data/lib/jets/cli/help/curl.md

@@ -0,0 +1,82 @@
+The `jets curl` command mimics the curl interface and directly invokes the AWS Lambda function. It is helpful in debugging the underlying Lambda event and response structure.
+
+Key points:
+
+* The `jets curl` command calls the AWS Lambda function with the `invoke` API call.
+* It translates the curl-like options into a Lambda Function URL event payload.
+* The event is sent to your Jets controller Lambda function.
+* The **raw** Lambda Function response is sent back.
+* You can pipe this to `jq` for pretty output.
+
+Example:
+
+    ❯ jets curl / | jq
+    Calling Lambda function event-app-dev-controller
+    Response:
+    {
+    "statusCode": 200,
+    "headers": {
+        "Content-Type": "text/plain"
+    },
+    "body": "Hello, World!",
+    "cookies": [
+        "my_cookie=my_value; Path=/"
+    ],
+    "isBase64Encoded": false
+    }
+
+Only a path is needed. IE: When you don't need to specify a hostname, Jets mimics with a dummy one, IE: dummy.lambda-url.us-west-2.on.aws. If you specify the hostname, `jets curl` will use that value instead of a dummy url.
+
+The `jets curl` command provides some of the curl interfaces but does not cover all curl options exhaustively.
+
+## Examples Cheatsheet
+
+    jets curl / | jq
+    jets curl /posts | jq
+    jets curl / --cookie cookies.txt | jq
+    jets curl / --cookie "cookie1=value1; cookie2=value2"
+    jets curl / --cookie-jar cookies.txt | jq
+    jets curl / -H Host:example.com
+    jets curl / -X POST -d "foo=bar"
+    jets curl foobar.lambda-url.us-west-2.on.aws/
+    jets curl / --verbose | jq
+    jets curl / --verbose --trim | jq
+
+## Multiple Headers
+
+The Thor CLI parses multiple options differently than curl does. Here's how you pass multiple headers.
+
+    jets curl / -H User-Agent:james-bond Host:example.com
+
+## Trim Option
+
+The `--trim` options "trims" values from the Lambda Response Hash to shortened the output so that it's more human-readable. The default trim max length is 64. You can adjust it with the `JETS_CURL_TRIM_MAX` env var.
+
+    export JETS_CURL_TRIM_MAX=32
+    jets curl / | jq
+
+## Cookies
+
+You can pass it request cookies with `--cookie` or `-b`.
+
+The `--cookie` option takes a string with values like so:
+
+    jets curl / --cookie "cookie1=value1; cookie2=value2"
+
+To write the response cookies to a file, use the `--cookie-jar` or `-c` option. Example:
+
+    jets curl / --verbose --trim -c cookies.txt
+
+Creates:
+
+cookies.txt
+
+    # HTTP Cookie File
+    dummy.lambda-url.us-west-2.on.aws    FALSE   /       FALSE   0       yummy1    value1
+    dummy.lambda-url.us-west-2.on.aws    FALSE   /       FALSE   0       yummy2    value2
+
+You can also see the response cookies in the Lambda response hash structure.
+
+Saving the cookies.txt is useful to send it later.
+
+    jets curl / -b cookies.txt

data/lib/jets/{command → cli}/help/delete.md

@@ -1,4 +1,4 @@
-This deletes the all the contents in the internal s3 bucket that jets uses and the associated CloudFormation stacks.
+Deletes the Jets deployment and all resources associated with it.
 
 ## Examples
 
@@ -6,7 +6,7 @@ This deletes the all the contents in the internal s3 bucket that jets uses and t
     Deleting project...
     Are you sure you want to want to delete the 'demo-dev' project? (y/N)
     y
-    First, deleting objects in s3 bucket demo-dev-s3bucket-89jrrj60c7bj
+    Emptying s3 bucket demo-dev-s3bucket-89jrrj60c7bj
     Deleting demo-dev...
     05:14:09AM DELETE_IN_PROGRESS AWS::CloudFormation::Stack demo-dev User Initiated
     ...
@@ -17,6 +17,6 @@ This deletes the all the contents in the internal s3 bucket that jets uses and t
     Project demo-dev deleted!
     $
 
-You can bypass the are you sure prompt with the `--yes` flag.
+You can bypass the are you sure prompt with the `-y` flag.
 
-    $ jets delete --yes
+    $ jets delete --y

data/lib/jets/cli/help/deploy.md

@@ -0,0 +1,5 @@
+Deploys project to AWS Lambda.
+
+## Example
+
+    $ jets deploy

data/lib/jets/cli/help/dotenv/get.md

@@ -0,0 +1,4 @@
+## Example
+
+    ❯ jets dotenv:get NAME1
+    value1

data/lib/jets/cli/help/dotenv/list.md

@@ -0,0 +1,5 @@
+## Example
+
+    ❯ jets dotenv:list
+    NAME1=value1
+    NAME2=value2

data/lib/jets/cli/help/dotenv/set.md

@@ -0,0 +1,25 @@
+## Examples
+
+An SSM Parameter name is conventionally used based on JETS_ENV and the Jets project in `config/jets/project.rb`. Example:
+
+    ❯ jets dotenv:set NAME1=value1 NAME2=value2
+    Will set the SSM vars for demo-dev
+
+      /demo/dev/NAME1
+      /demo/dev/NAME2
+
+    Are you sure? (y/N) y
+    Setting SSM vars for demo-dev
+    SSM Parameter set: /demo/dev/NAME1
+    SSM Parameter set: /demo/dev/NAME2
+
+If the env var includes a / then the SSM parameter is assumed to be fully qualified, there is conventional name expansion, and it is used as it.
+
+    ❯ jets dotenv:set /dev/NAME1=value1
+    Will set the SSM vars for sinatra-dev
+
+      /dev/NAME1
+
+    Are you sure? (y/N) y
+    Setting SSM vars for sinatra-dev
+    SSM Parameter set: /dev/NAME1

data/lib/jets/cli/help/dotenv/unset.md

@@ -0,0 +1,12 @@
+## Example
+
+    ❯ jets dotenv:unset NAME1 NAME2
+    Will delete the SSM vars for demo-dev
+
+      /demo/dev/NAME1
+      /demo/dev/NAME2
+
+    Are you sure? (y/N) y
+    Setting SSM vars for demo-dev
+    SSM Parameter deleted: /demo/dev/NAME1
+    SSM Parameter deleted: /demo/dev/NAME2

data/lib/jets/cli/help/exec.md

@@ -0,0 +1,53 @@
+Execute commands on AWS Lambda environment.
+
+## REPL
+
+When no command is provided a REPL is started.
+
+    ❯ jets exec
+    > pwd
+    /var/task
+    > whoami
+    sbx_user1051
+    > echo $AWS_REGION
+    us-west-2
+    > env | sort
+
+More examples:
+
+    ❯ jets exec
+    > env | sort
+    > cat /etc/os-release
+    > du -sh * | sort -sh
+
+## Execute Commands
+
+    ❯ jets exec uname -a
+    Linux ... GNU/Linux
+
+## Status and Result
+
+You can see the status and result of the last command executed on AWS Lambda. Example:
+
+    ❯ jets exec
+    > whoami
+    sbx_user1051
+    > status
+    Last command had a status of success (0).
+    > result
+    Last result:
+    {
+      "stdout": "sbx_user1051\n",
+      "stderr": "",
+      "status": 0
+    }
+    > echo "This is an error message" >&2
+    This is an error message
+    > result
+    Last result:
+    {
+      "stdout": "",
+      "stderr": "This is an error message\n",
+      "status": 0
+    }
+    >

data/lib/jets/cli/help/generate/event.md

@@ -0,0 +1,11 @@
+## Examples
+
+    jets generate:event log --trigger log --method report
+    jets generate:event cool --trigger scheduled
+    jets generate:event security --trigger rule --method detect_security_group_changes
+    jets generate:event clerk --trigger dynamodb --method file
+    jets generate:event thermostat --trigger iot --method measure
+    jets generate:event data --trigger kinesis --method file
+    jets generate:event upload --trigger s3
+    jets generate:event messenger --trigger sns --method deliver
+    jets generate:event waiter --trigger sqs --method order

data/lib/jets/{command → cli}/help/logs.md

@@ -1,6 +1,6 @@
 Show logs from Lambda function CloudWatch log group.
 
-This defaults to the controller Lambda function in the `one_lambda_for_all_controllers` mode.  Example:
+This defaults to the controller Lambda function.  Example:
 
     ❯ jets logs
     Showing logs for /aws/lambda/demo-dev-controller
@@ -12,7 +12,7 @@ If you want to follow the logs use the `-f` flag.
 
 If you want to see the production logs:
 
-    ❯ JETS_ENV=production jets logs -f
+    ❯ JETS_ENV=prod jets logs -f
     Tailing logs for /aws/lambda/demo-prod-controller
 
 If you want to see logs for a job, specify the job and method.

data/lib/jets/{command/help/releases.md → cli/help/release/history.md}

@@ -1,6 +1,6 @@
 ## Examples
 
-    $ jets releases
+    $ jets release:history
     Releases for stack: demo-dev
     +---------+-----------------+--------------+---------+
     | Version |     Status      | Released At  | Message |
@@ -12,8 +12,8 @@
 
 The shown releases are paginated. If you need to see more releases you can use the `--page` option.
 
-    $ jets releases --page 2
+    $ jets release:history --page 2
 
 ## Other Commands
 
-  releases:info      View detailed information for a release
+  release:info      View detailed information for a release

data/lib/jets/cli/help/rollback.md

@@ -0,0 +1,5 @@
+## Examples
+
+    jets rollback 8
+
+Use the [jets release:history](/reference/jets-release-history/) command to view release history.

data/lib/jets/cli/help/schedule/validate.md

@@ -0,0 +1 @@
+Validate config/jets/schedule.yml by creating and deleting live event rules.

data/lib/jets/{command → cli}/help/status.md

@@ -8,7 +8,7 @@ The CloudFormation stack status info. Essentially the events of the CloudFormati
     05:21:42AM UPDATE_IN_PROGRESS AWS::CloudFormation::Stack demo-dev User Initiated
     05:21:45AM CREATE_IN_PROGRESS AWS::CloudFormation::Stack ApiGateway
     ...
-    05:23:22AM CREATE_COMPLETE AWS::CloudFormation::Stack JetsPreheatJob
+    05:23:22AM CREATE_COMPLETE AWS::CloudFormation::Stack JetsPrewarmEvent
     05:23:25AM UPDATE_COMPLETE_CLEANUP_IN_PROGRESS AWS::CloudFormation::Stack demo-dev
     05:23:25AM UPDATE_COMPLETE AWS::CloudFormation::Stack demo-dev
     $

data/lib/jets/cli/help.rb

@@ -0,0 +1,16 @@
+class Jets::CLI
+  module Help
+    extend self
+    def text(namespaced_command)
+      file = namespaced_command.to_s.tr(":", "/")
+      path = File.expand_path("../help/#{file}.md", __FILE__)
+      return IO.read(path) if File.exist?(path)
+
+      # Also look up for a help folder within the current command folder
+      called_from = caller(1..1).first.split(":").first
+      unnamespaced_command = namespaced_command.to_s.split(":").last
+      path = File.expand_path("../help/#{unnamespaced_command}.md", called_from)
+      IO.read(path) if File.exist?(path)
+    end
+  end
+end

data/lib/jets/cli/init/detect.rb

@@ -0,0 +1,30 @@
+class Jets::CLI::Init
+  class Detect
+    def framework
+      gems.each do |gem|
+        frameworks.each do |framework|
+          return framework if gem == framework
+        end
+      end
+      nil
+    end
+
+    def frameworks
+      %w[
+        rails
+        sinatra
+        hanami
+        grape
+      ]
+    end
+
+    def gems
+      return [] unless File.exist?("Gemfile")
+      Bundler.with_unbundled_env do
+        gemfile_content = File.read("Gemfile")
+        dsl = Bundler::Dsl.evaluate(Bundler.default_gemfile, gemfile_content, {})
+        dsl.dependencies.map(&:name)
+      end
+    end
+  end
+end

data/lib/jets/cli/init/templates/config/jets/bootstrap.rb.tt

@@ -0,0 +1,16 @@
+Jets.bootstrap.configure do
+  # Docs: http://rubyonjets.com/docs/remote/codebuild/
+  # config.codebuild.project.env.vars = {
+  #   BUNDLE_GITHUB__COM: "SSM:/#{ssm_env}/BUNDLE_GITHUB__COM",
+  #   DOCKER_PASS: "SSM:/#{ssm_env}/DOCKER_PASS",
+  #   DOCKER_USER: "SSM:/#{ssm_env}/DOCKER_USER",
+  #   # Tip: Use your own Docker host for faster deploys
+  #   DOCKER_HOST: "SSM:/#{ssm_env}/DOCKER_HOST",
+  #   JETS_SSH_KEY: "SSM:/#{ssm_env}/JETS_SSH_KEY",
+  #   JETS_SSH_KNOWN: "SSM:/#{ssm_env}/JETS_SSH_KNOWN"
+  # }
+
+  # Additional codebuild remote-lambda runner for commands that can leverage it
+  # Docs: https://docs.rubyonjets.com/docs/remote/codebuild/compute-type/#lambda-compute-type
+  # config.codebuild.lambda.enable = true
+end

data/lib/jets/cli/init/templates/config/jets/deploy.rb.tt

@@ -0,0 +1,43 @@
+Jets.deploy.configure do
+<% unless framework == "rails" -%>
+  # https://docs.rubyonjets.com/docs/config/package-type/
+  # config.package_type = "image" # default: image IE: image or zip
+
+<% end -%>
+<% if framework == "rails" -%>
+  # https://docs.rubyonjets.com/docs/jobs/
+  # config.job.enable = true
+
+<% end -%>
+  # Docker https://docs.rubyonjets.com/docs/docker/dockerfile/managed/
+  # config.dockerfile.packages.apt.build_stage = ["default-libmysqlclient-dev"]
+  # config.dockerfile.packages.apt.deployment_stage = ["default-mysql-client"]
+
+  # CloudFront Lambda URL https://docs.rubyonjets.com/docs/routing/lambda/cloudfront/distribution/
+  # config.lambda.url.cloudfront.enable = true
+  # config.lambda.url.cloudfront.cert.arn = acm_cert_arn("domain.com", region: "us-east-1")
+  # config.lambda.url.cloudfront.route53.enable = true
+
+  # WAF https://docs.rubyonjets.com/docs/routing/lambda/cloudfront/waf/
+  # config.lambda.url.cloudfront.web_acl_id = web_acl_arn(ssm_env, scope: "CLOUDFRONT")
+  # config.waf.rules = ["AWSManagedRulesSQLiRuleSet"]
+
+  # Scaling https://docs.rubyonjets.com/docs/config/provisioned-concurrency/
+  # config.lambda.controller.provisioned_concurrency = 1  # costs money, no cold start
+  # config.lambda.controller.reserved_concurrency = 10    # free and limits scaling
+
+  # Release phase https://docs.rubyonjets.com/docs/hooks/remote/release/
+  # config.release.phase.command = "bundle exec rails db:migrate"
+
+  # CI https://docs.rubyonjets.com/docs/ci/getting-started/
+  # use jets ci:init to add these settings automatically
+  # config.ci.source = {
+  #   Type: "GITHUB",
+  #   Location: "https://github.com/ORG/REPO"
+  # }
+  # config.ci.source_version = "main"
+  # config.ci.env.vars = {
+  #   BUNDLE_GITHUB__COM: "SSM:/#{ssm_env}/BUNDLE_GITHUB__COM",
+  #   JETS_API_KEY: "SSM:/#{ssm_env}/JETS_API_KEY"
+  # }
+end

data/lib/jets/cli/init/templates/config/jets/project.rb.tt

@@ -0,0 +1,3 @@
+Jets.project.configure do
+  config.name = "<%= init_project_name %>"
+end

data/lib/jets/cli/init/templates/env/.env.tt

@@ -0,0 +1,18 @@
+# Docs: https://docs.rubyonjets.com/docs/env/files/
+# This file is optional.
+# It's recommended to use SSM parameters with conventional paths instead.
+# See: https://docs.rubyonjets.com/docs/env/ssm/conventions/
+<% if framework == "rails" -%>
+RAILS_ENV=production
+RAILS_LOG_TO_STDOUT=1
+# SECRET_KEY_BASE=SSM  # SSM:/<%= init_project_name %>/dev/SECRET_KEY_BASE remember to set a secret key base
+<% end -%>
+
+# Examples:
+# No Conventions:
+# KEY1=value1 # hard coded value
+# KEY2=SSM:/abs/path/to/KEY2
+# Conventions https://docs.rubyonjets/docs/env/ssm/conventions/
+# SSM path under /<%= init_project_name %>/dev/ are autoloaded.
+# You can also control this behavior and then manually declare the SSM parameter.
+# DATABASE_URL=SSM  # SSM:/<%= init_project_name %>/dev/DATABASE_URL