jets-fs 1.6.10

data/lib/jets/commands/deploy.rb

@@ -0,0 +1,131 @@
+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..."
+      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
+
+      ship(stack_type: :full, s3_bucket: s3_bucket)
+    end
+
+    def delete_minimal_stack
+      puts "Existing stack is in ROLLBACK_COMPLETE state from a previous failed minimal deploy. Deleting stack and continuing."
+      cfn.delete_stack(stack_name: stack_name)
+      status.wait
+      status.reset
+    end
+
+    def check_dev_mode
+      if File.exist?("#{Jets.root}/dev.mode")
+        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!
+      check_route_connected_functions
+    end
+
+    # Checks that all routes are validate and have corresponding lambda functions
+    def check_route_connected_functions
+      return if Jets::Router.all_routes_valid
+
+      puts "Deploy fail: The jets application contain invalid routes.".color(:red)
+      puts "Please double check the routes below map to valid controllers:"
+      Jets::Router.invalid_routes.each do |route|
+        puts "  /#{route.path} => #{route.controller_name}##{route.action_name}"
+      end
+      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
+      Jets::Cfn::Ship.new(options).run
+    end
+
+    def status
+      Jets::Cfn::Status.new(stack_name)
+    end
+    memoize :status
+
+    def stack_name
+      Jets::Naming.parent_stack_name
+    end
+
+    # Checks for a few things before deciding to delete the parent stack
+    #
+    #   * Parent stack status status is ROLLBACK_COMPLETE
+    #   * Parent resources are in the DELETE_COMPLETE state
+    #
+    def minimal_rollback_complete?
+      stack = find_stack(stack_name)
+      return false unless stack
+
+      return false unless stack.stack_status == 'ROLLBACK_COMPLETE'
+
+      # Finally check if all the minimal resources in the parent template have been deleted
+      resp = cfn.describe_stack_resources(stack_name: stack_name)
+      resource_statuses = resp.stack_resources.map(&:resource_status).uniq
+      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!
+      stack_name = Jets::Naming.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$/
+        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 "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

data/lib/jets/commands/dynamodb.rb

@@ -0,0 +1,22 @@
+module Jets::Commands
+  class Dynamodb < Jets::Commands::Base
+    autoload :Migrator, 'jets/commands/dynamodb/migrator'
+    autoload :Migrate, 'jets/commands/dynamodb/migrate'
+
+    desc "migrate [path]", "Runs migrations"
+    long_desc Help.text('dynamodb:migrate')
+    def migrate(path)
+      Migrator.new(path, options).run
+    end
+
+    desc "generate [name]", "Creates a migration for a DynamoDB table"
+    long_desc Help.text('dynamodb:generate')
+    option :partition_key, default: "id:string:hash", desc: "table's partition key"
+    option :sort_key, default: nil, desc: "table's sort key"
+    option :table_name, desc: "override the the conventional table name"
+    option :table_action, desc: "create_table or update_table. Defaults to convention based on the name of the migration."
+    def generate(name)
+      Dynomite::Migration::Generator.new(name, options).generate
+    end
+  end
+end

data/lib/jets/commands/dynamodb/migrate.rb

@@ -0,0 +1,9 @@
+class Jets::Commands::Dynamodb::Migrate < Jets::Commands::Base
+  desc "down", "Runs migrations down"
+  # desc "migrate:down [path]", "Runs migrations down"
+  # long_desc Help.migrate
+  def down#(path)
+    # Migrate.new(path, options).run
+    puts "Jets::Commands::Dynamodb::Down ran"
+  end
+end

data/lib/jets/commands/dynamodb/migrator.rb

@@ -0,0 +1,36 @@
+begin
+  require "dynomite"
+rescue LoadError # Commands::Base.eager_load
+  nil
+end
+
+class Jets::Commands::Dynamodb::Migrator
+  def initialize(path, options)
+    @path = path
+    @options = options
+  end
+
+  def run
+    puts "Running database migrations"
+    return if @options[:noop]
+    migrate
+  end
+
+  def migrate
+    path = "#{Jets.root}/#{@path}"
+    unless File.exist?(path)
+      puts "Unable to find the migration file: #{path}"
+      exit 1 unless ENV['TEST']
+    end
+
+    require path
+    migration_class = get_migration_class
+    migration_class.new.up
+  end
+
+  def get_migration_class
+    filename = File.basename(@path, '.rb')
+    filename = filename.sub(/\d+[-_]/, '') # strip leading timestsamp
+    filename.classify.constantize
+  end
+end

data/lib/jets/commands/gems.rb

@@ -0,0 +1,21 @@
+module Jets::Commands
+  class Gems < Jets::Commands::Base
+    desc "check", "Check if pre-built Lambda gems are available from the sources"
+    long_desc Help.text("gems:check")
+    def check
+      check = Jets::Gems::Check.new(cli: true)
+      check.run! # exits early if missing gems found
+      # If reach here, means all gems are ok.
+      puts "Congrats! All gems are available in as pre-built Lambda gems 👍"
+    end
+
+    desc "sources", "List pre-built Lambda gem sources"
+    long_desc Help.text("gems:sources")
+    def sources
+      puts "Your pre-built Lambda gem sources are:"
+      Jets.config.gems.sources.each do |source|
+        puts "  #{source}"
+      end
+    end
+  end
+end

data/lib/jets/commands/help.rb

@@ -0,0 +1,9 @@
+module Jets::Commands::Help
+  class << self
+    def text(namespaced_command)
+      path = namespaced_command.to_s.gsub(':','/')
+      path = File.expand_path("../help/#{path}.md", __FILE__)
+      IO.read(path) if File.exist?(path)
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+Builds a zip file package to be uploaded to AWS Lambda. This allows you to build the project without deploying and inspect the zip file that gets deployed to AWS Lambda. The package contains:
+
+* your application code
+* generated shims
+
+If the application has no Ruby code and only uses Polymorphic functions, then gems are not bundled up.

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

@@ -0,0 +1,61 @@
+## Remote mode
+
+Invoke the lambda function on AWS. The `jets call` command does a few extra things for your convenience:
+
+It adds the function namespace to the function name.  So, you pass in `posts_controller-index` and the Lambda function is `demo-dev-posts_controller-index`.
+
+CLI Name | Lambda Function
+--- | ---
+posts_controller-index | demo-dev-posts_controller-index
+
+The `jets call` command can also print out the last 4KB of the lambda logs with the `--show-logs` 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`.
+
+For [controllers](http://rubyonjets.com/docs/controllers/), the event you pass at the CLI is automatically transformed into [Lambda Proxy](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html) payload that contains the params as the `queryStringParameters`.  For example:
+
+    {"test":1}
+
+Gets changed to:
+
+    {"queryStringParameters":{"test":1}}
+
+This spares you from assembling the event payload manually to the payload that Jets controllers normally receive.  If you would like to disable this Lambda Proxy transformation then use the `--no-lambda-proxy` flag.
+
+For [jobs](http://rubyonjets.com/docs/jobs/), the event is passed through untouched.
+
+## Examples
+
+    jets call hard_job-drive '{"test":1}'
+    jets call hard_job-drive '{"test":1}' | jq .
+    jets call hard_job-drive file://event.json | jq . # load event with a file
+    jets call posts_controller-index # event payload is optional
+    jets call posts_controller-index '{"test":1}' --show-log | jq .
+    jets call posts_controller-index 'file://event.json' --show-log | jq .
+
+The equivalent AWS Lambda CLI command:
+
+    aws lambda invoke --function-name demo-dev-hard_job-dig --payload '{"test":1}' outfile.txt
+    cat outfile.txt | jq '.'
+
+    aws lambda invoke --function-name demo-dev-posts_controller-index --payload '{"queryStringParameters":{"test":1}}' outfile.txt
+    cat outfile.txt | jq '.'
+
+For convenience, you can also provide the function name with only dashes and `jets call` figures out what function you intend to call. Examples:
+
+    jets call posts-controller-index
+    jets call admin-related-pages-controller-index
+
+Are the same as:
+
+    aws lambda invoke --function-name demo-dev-posts_controller-index
+    aws lambda invoke --function-name demo-dev-admin/related_pages_controller-index
+
+Jets figures out what functions to call by evaluating the app code and finds if the controller and method exists.  If you want to turn guess mode off and want to always explicitly provide the method name use the `--no-guess` option.  The function name will then have to match the lambda function without the namespace. Example:
+
+    jets call admin-related_pages_controller-index --no-guess
+
+## Local mode
+
+Instead of calling AWS lambda remote, you can also have `jets call` use the code directly on your machine.  To enable this, use the `--local` flag. Example:
+
+    jets call hard_job-drive --local
+

data/lib/jets/commands/help/clean/build.md

@@ -0,0 +1,5 @@
+Removes the build files that jets creates. Essentially, deletes `/tmp/jets`. This will remove all build files for all jets projects. This is safe as jets uses `/tmp/jets` merely as a cache to speed up incrementally builds. Cleaning this out can clean up cruft in the `/tmp/jets` directory that builds over time.
+
+## Example
+
+    jets clean:build

data/lib/jets/commands/help/clean/log.md

@@ -0,0 +1,5 @@
+Essentially removes the CloudWatch groups assocated with the app. Lambda requests re-create the log groups so this is pretty safe to do.
+
+## Example
+
+    jets log:clean

data/lib/jets/commands/help/console.md

@@ -0,0 +1,18 @@
+## Example
+
+    $ jets console
+    >> Post.table_name
+    => "posts"
+    >> ActiveRecord::Base.connection.tables
+    => ["schema_migrations", "ar_internal_metadata", "posts"]
+    >> Jets.env
+    => "development"
+    >>
+
+## Use .env.development.remote
+
+To use the remote values also in the `jets console` you can use the `JETS_ENV_REMOTE=1` env variable. Example:
+
+    JETS_ENV_REMOTE=1 jets console
+
+More info at [Env Files](http://rubyonjets.com/docs/env-files/)

data/lib/jets/commands/help/db/generate.md

@@ -0,0 +1,8 @@
+Generates migration in `db/migrate`
+
+## Examples
+
+    jets db:generate create_articles title:string user_id:integer
+    jets db:generate AddTitleBodyToPost title:string body:text published:boolean
+
+This task delegates to Rails `rails generate migration`.  For more examples, refer to the [Active Record Migrations Rails Guide](https://edgeguides.rubyonrails.org/active_record_migrations.html).

data/lib/jets/commands/help/dbconsole.md

@@ -0,0 +1,9 @@
+This is like running the psql command with the `config/database.yml` values and set for you.
+
+## Example
+
+    $ jets dbconsole
+    psql (9.2.24)
+    Type "help" for help.
+
+    demo_dev=>

data/lib/jets/commands/help/delete.md

@@ -0,0 +1,22 @@
+This deletes the all the contents in the internal s3 bucket that jets uses and the associated CloudFormation stacks.
+
+## Examples
+
+    $ jets delete
+    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
+    Deleting demo-dev...
+    05:14:09AM DELETE_IN_PROGRESS AWS::CloudFormation::Stack demo-dev User Initiated
+    ...
+    05:14:23AM DELETE_IN_PROGRESS AWS::CloudFormation::Stack PostsController
+    05:15:31AM DELETE_COMPLETE AWS::S3::Bucket S3Bucket
+    Stack demo-dev deleted.
+    Time took for deletion: 1m 27s.
+    Project demo-dev deleted!
+    $
+
+You can bypass the are you sure prompt with the `--sure` flag.
+
+    $ jets delete --sure

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

@@ -0,0 +1,32 @@
+This builds the project and deploys it AWS Lambda. The deployment is mainly handled by CloudFormation.  To check on the status of the deploy you can also check the CloudFormation console.
+
+![](http://rubyonjets.com/img/cli/deploy-cloudformation-status.png)
+
+## Example
+
+    $ jets deploy
+    Deploying to Lambda demo-dev environment...
+    => Compling assets in current project directory
+    => Copying current project directory to temporary build area: /tmp/jets/demo/app_root
+    => Tidying project: removing ignored files to reduce package size.
+    => Generating node shims in the handlers folder.
+    => Bundling: running bundle install in cache area: /tmp/jets/demo/cache.
+    => Setting up a vendored copy of ruby.
+    => Replacing compiled gems with AWS Lambda Linux compiled versions.
+    Creating zip file.
+    => cd /tmp/jets/demo/app_root && zip --symlinks -rq /tmp/jets/demo/code/code-temp.zip .
+    Building CloudFormation templates.
+    Deploying CloudFormation stack with jets app!
+    Uploading /tmp/jets/demo/code/code-7169d0ac.zip (88.8 MB) to S3
+    Time to upload code to s3: 1s
+    Deploying CloudFormation stack with jets app!
+    02:08:20AM UPDATE_IN_PROGRESS AWS::CloudFormation::Stack demo-dev User Initiated
+    02:08:23AM CREATE_IN_PROGRESS AWS::CloudFormation::Stack ApiGateway
+    ...
+    02:08:48AM CREATE_IN_PROGRESS AWS::CloudFormation::Stack PostsController
+    02:10:03AM UPDATE_COMPLETE AWS::CloudFormation::Stack demo-dev
+    Stack success status: UPDATE_COMPLETE
+    Time took for stack deployment: 1m 46s.
+    Prewarming application.
+    API Gateway Endpoint: https://ewwnealfk0.execute-api.us-west-2.amazonaws.com/dev/
+    $

data/lib/jets/commands/help/dynamodb/generate.md

@@ -0,0 +1,52 @@
+Generates a migration file which can be used to create a DynamoDB table.  To run the migration file use `jets dynamodb:migrate`.
+
+The table name will have a namespace. For example, if your project is called `demo`, the environment is `development`, and you create a table called `posts`.  The DynamoDB full table name will be `demo-dev-posts`.  You can change this behavior by editing your `config/dynamodb.yml` and adjusting the `table_namespace` value.
+
+DynamoDB tables support certain types of attribute types. The CLI will parse the `--partition-key` option and use the second part of the option to map it to the underlying DynamoDB type using this mapping.
+
+```ruby
+ATTRIBUTE_TYPE_MAP = {
+  'string' => 'S',
+  'number' => 'N',
+  'binary' => 'B',
+  's' => 'S',
+  'n' => 'N',
+  'b' => 'B',
+}
+```
+
+For example, `--partition-key id:string`  maps 'string' to 's'.  More info on DynamoDB types is available at the ruby aws-sdk docs: [Aws::DynamoDB::Types::AttributeDefinition](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Types/AttributeDefinition.html)
+
+## Examples
+
+    $ jets dynamodb:generate create_posts --partition-key id # default attribute type is string
+    $ jets dynamodb:generate create_posts --partition-key id:number # attribute type will be number
+    $ jets dynamodb:generate create_comments --partition-key post_id:string --sort-key created_at:string
+
+## Running migrations
+
+    $ jets dynamodb:migrate path/to/migration
+    $ jets dynamodb:migrate dynamodb/migrate/20171112162404-create_articles_migration.rb
+
+To add global secondary indexes:
+
+    $ jets dynamodb:generate update_comments --partition-key user_id:string --sort-key created_at:string
+
+To run:
+
+    $ jets dynamodb:migrate dynamodb/migrate/20171112161530-create_posts_migration.rb
+
+## Conventions
+
+A create_table or update_table migration file is generated based name you provide.  If `update` is included in the name then an update_table migration table is generated. If `create` is included in the name then a create_table migration table is generated.
+
+The table_name is also inferred from the migration name you provide.  Examples:
+
+    $ jets dynamodb:generate create_posts # table_name: posts
+    $ jets dynamodb:generate update_comments # table_name: comments
+
+You can override both of these conventions:
+
+    $ jets dynamodb:generate create_my_posts --table-name posts
+    $ jets dynamodb:generate my_posts --table-action create_table --table-name posts
+    $ jets dynamodb:generate my_posts --table-action update_table --table-name posts