jets 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5e19887ba1605e079b1c49a85a4f37088f3c5fc79a6b0863b979d2c3916c7ab
-  data.tar.gz: 470eac8944fd085fe23a8eb79ba26ebdb5704dbee844688df9a4bcad4862d6df
+  metadata.gz: 99d211e564c05c5406aa02c2524c6c3c31b31ebc8b5887453c6241428318a1cf
+  data.tar.gz: 68fec88d0f05af3763a9fa03be35c2dee56b5d5957195dcc4ff85cd4b092ef50
 SHA512:
-  metadata.gz: 6f7e9cc5798a1bafd67c32d5ae7b1c85b00ee354a0f1ecd93f9c02e595a75afee7216ffaf5f8764e74e8ace43b831353cc4813f439bca319eabf5628a861d19c
-  data.tar.gz: 8f21f6e699661a2734f9632d51e3aa20404979c57d5ec6bc52f7c4f498f32efcc2160840c03af8c414083eb53124fdec300501352af231b2bfc17c7e4d4d8f7a
+  metadata.gz: dad39bb8411c0692e262de6178d41cdacd6293c7dc95672ea7581500801c9bfc500a1394d3325701dc049743e769f4701210df5f5f46b3ff2791eda11fcabb60
+  data.tar.gz: 35a72039c9f9afc6500a5d8317d67d42132b72712f9f12ecf5f30663eace1222ec58f6d36251ec441de675db366e2eca2122340cf9dcab54c8323ea888da7564

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.6.3]
+- fix app logging: pull request #14
+
 ## [0.6.2]
 - add versions to gemspec dependencies
 

data/Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    jets (0.6.2)
+    jets (0.6.3)
       actionpack (>= 5.2.1)
       actionview (>= 5.2.1)
       activerecord (>= 5.2.1)
@@ -72,7 +72,7 @@ GEM
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-dynamodb (1.10.0)
+    aws-sdk-dynamodb (1.11.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sdk-kms (1.7.0)

data/README.md

@@ -1,12 +1,12 @@
 <div align="center">
-  <link href="http://rubyonjets.com"><img src="http://rubyonjets.com/img/logos/jets-logo.png" /></img>
+  <a href="http://rubyonjets.com"><img src="http://rubyonjets.com/img/logos/jets-logo.png" /></a>
 </div>
 
+Ruby and Lambda splat out a baby and that child's name is [Jets](http://rubyonjets.com/).
+
 ![Build Status](https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiUE12K3ljQTFQUjVpRW0reGhGVHVQdkplTHlOdUtENnBya2JhVWVXaFIvTU92MlBtV3hIUE9pb25jWGw0MS9jN2RXMERKRHh5Nzhvd01Za0NyeUs5SCtzPSIsIml2UGFyYW1ldGVyU3BlYyI6IkMybEJFaXdzejJEaHNWVmEiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)
 [![CircleCI](https://circleci.com/gh/tongueroo/jets.svg?style=svg)](https://circleci.com/gh/tongueroo/jets)
 
-Ruby and Lambda splat out a baby and that child's name is Jets.
-
 ## What is Jets?
 
 Jets is a Ruby Serverless Framework.  Jets allows you to create serverless applications with a beautiful language: Ruby.  It includes everything required to build an application and deploy it to AWS Lambda.
@@ -24,7 +24,7 @@ Refer to the official docs for more info, but here's a quick intro.
 
 A Jets controller handles a web request and renders a response.  Here's an example:
 
-`app/controllers/posts_controller.rb`:
+app/controllers/posts_controller.rb:
 
 ```ruby
 class PostsController < ApplicationController
@@ -48,7 +48,7 @@ Jets creates Lambda functions each the public method in your controller.
 
 You connect Lambda functions to API Gateway URL endpoints with a routes file:
 
-`config/routes.rb`:
+config/routes.rb:
 
 ```ruby
 Jets.application.routes.draw do
@@ -74,9 +74,11 @@ Test your API Gateway endpoints with curl or postman. Note, replace the URL endp
 	  "action": "index"
 	}
 
-### Jets Workers
+### Jets Jobs
+
+A Jets job handles asynchrous background jobs performed outside of the web request/response cycle. Here's an example:
 
-A Jets worker handles background jobs.  It is performed outside of the web request/response cycle. Here's an example:
+app/jobs/hard_job.rb:
 
 ```ruby
 class HardJob < ApplicationJob
@@ -92,7 +94,7 @@ class HardJob < ApplicationJob
 end
 ```
 
-`HardJob#dig` will be ran every 10 hours and `HardJob#lift` will be ran every 12 hours.
+`HardJob#dig` runs every 10 hours and `HardJob#lift` runs every 12 hours.
 
 ### Jets Deployment
 

data/lib/jets/aws_info.rb

@@ -5,7 +5,7 @@ module Jets
     include AwsServices
 
     def region
-      return 'us-east-1' if ENV['TEST']
+      return 'us-east-1' if test?
 
       region = nil
 
@@ -28,9 +28,13 @@ module Jets
 
     # aws sts get-caller-identity
     def account
-      return '123456789' if ENV['TEST']
+      return '123456789' if test?
       sts.get_caller_identity.account
     end
     memoize :account
+
+    def test?
+      ENV['TEST'] || ENV['CIRCLECI']
+    end
   end
 end

data/lib/jets/booter.rb

@@ -1,10 +1,10 @@
 class Jets::Booter
   class << self
     @booted = false
-    def boot!
+    def boot!(options={})
       return if @booted
 
-      stdout_to_stderr
+      redirect_output(options)
       confirm_jets_project!
       require_bundle_gems
       Jets::Dotenv.load!
@@ -14,16 +14,37 @@ class Jets::Booter
       @booted = true
     end
 
-    # Override for Lambda processing.
-    # $stdout = $stderr might seem weird but we want puts to write to stderr which
-    # is set in the node shim to write to stderr.  This directs the output to
-    # Lambda logs.
-    # Printing to stdout managles up the payload returned from Lambda function.
-    # This is not desired when returning payload to API Gateway eventually.
-    def stdout_to_stderr
+    # TODO: Reconsider if we should redirect stdout to stderr globally for local request.
+    # Dont think we need to anymore now that we're not using the old shim.
+    #
+    # So for `{stringio: false}` and `jets call --local`, redirecting helps
+    # but we can also just go fix that jets call method. Though there might be a lot
+    # of other places where we might have to fix puts calls.
+    def redirect_output(options={})
       $stdout.sync = true
       $stderr.sync = true
-      $stdout = $stderr
+      if options[:stringio]
+        # Set both $stdout and $stdout to a StringIO object as a buffer.
+        # At the end of the request, write this buffer to the filesystem.
+        # In the node shim, read it back and write it to AWS Lambda logs.
+        #
+        # This allows using `puts` to write to CloudWatch.
+        $stdout = $stderr = StringIO.new # for ruby_server and AWS Lambda to capture log
+      else
+        # Printing to stdout can mangle up the response if we're piping the value to
+        # jq. For exampe, `jets call --local .. | jq`
+        # By redirecting stderr we can use jq.
+        #
+        $stdout = $stderr # jets call and local jets operation
+      end
+    end
+
+    # Used in ruby_server.rb
+    def flush_output
+      IO.write("/tmp/jets-output.log", $stdout.string)
+      # Thanks: https://stackoverflow.com/questions/28445000/how-can-i-clear-a-stringio-instance
+      $stdout.truncate(0)
+      $stdout.rewind
     end
 
     # require_bundle_gems called when environment boots up via Jets.boot.  It

data/lib/jets/builders/code_builder.rb

@@ -342,9 +342,11 @@ EOL
     # When using submodules, bundler leaves old submodules behind. Over time this inflates
     # the size of the the bundled gems.  So we'll clean it up.
     def clean_old_submodules
-      lockfile = "#{cache_area}/Gemfile.lock"
       # https://stackoverflow.com/questions/38800129/parsing-a-gemfile-lock-with-bundler
-      parser = Bundler::LockfileParser.new(Bundler.read_file(Bundler.default_lockfile))
+      lockfile = "#{cache_area}/Gemfile.lock"
+      return unless File.exist?(lockfile)
+
+      parser = Bundler::LockfileParser.new(Bundler.read_file(lockfile))
       specs = parser.specs
 
       # specs = Bundler.load.specs

data/lib/jets/builders/node-shim.js

@@ -2,10 +2,12 @@
 
 const spawn = require('child_process').spawn;
 const fs = require('fs');
+const readline = require('readline');
 const TMP_LOG_PATH = '/tmp/shim-subprocess.log';
 const subprocess_out = fs.openSync(TMP_LOG_PATH, 'a');
 const subprocess_err = fs.openSync(TMP_LOG_PATH, 'a');
 const JETS_DEBUG = process.env.JETS_DEBUG // set JETS_DEBUG=1 to see more debugging info
+const JETS_OUTPUT = '/tmp/jets-output.log';
 
 function once() {
   // Uncomment fake run once locally. No need to do this on real lambda environment.
@@ -112,6 +114,22 @@ function request(event, handler, callback) {
   	  return;
   	}
 
+    if (fs.existsSync(JETS_OUTPUT)) {
+      // Thanks: https://stackoverflow.com/questions/6156501/read-a-file-one-line-at-a-time-in-node-js
+      var rd = readline.createInterface({
+        input: fs.createReadStream(JETS_OUTPUT),
+        // output: process.stdout,
+        console: false
+      });
+
+      rd.on('line', function(line) {
+        // Important to use console.error in case locally testing shim or we see
+        // stdout "twice", once from here and once from ruby-land and it's confusing.
+        // AWS lambda will write console.error and console.log to CloudWatch.
+        console.error(line); // output to AWS Lambda Logs
+      });
+    }
+
     var resp = JSON.parse(stdout_buffer);
     if (resp["errorMessage"]) {
       // Customize error object for lambda format

data/lib/jets/commands/build.rb

@@ -113,6 +113,7 @@ module Jets::Commands
       expression = "#{Jets.root}app/**/**/*.rb"
       Dir.glob(expression).each do |path|
         return false unless File.file?(path)
+        next if path.include?("app/functions") # cannot lazy load these because they are anonymous classes
         next unless app_file?(path)
 
         relative_path = path.sub(Jets.root.to_s, '')

data/lib/jets/core.rb

@@ -28,8 +28,8 @@ module Jets::Core
   end
 
   # Load all application base classes and project classes
-  def boot
-    Jets::Booter.boot!
+  def boot(options={})
+    Jets::Booter.boot!(options)
   end
 
   # Ensures trailing slash

data/lib/jets/processors/main_processor.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'stringio'
 
 # Node shim calls this class to process both controllers and jobs
 class Jets::Processors::MainProcessor
@@ -59,5 +60,4 @@ class Jets::Processors::MainProcessor
       # $stderr.puts("END OF RUBY OUTPUT") # uncomment for debugging
     end
   end
-
 end

data/lib/jets/ruby_server.rb

@@ -1,5 +1,11 @@
 require 'socket'
 require 'json'
+require 'stringio'
+
+# Save copy of old stdout, since Jets.boot messes with it.
+# So we can use $normal_stdout.puts for debugging.
+$normal_stdout ||= $stdout
+$normal_stderr ||= $stderr
 
 # https://ruby-doc.org/stdlib-2.3.0/libdoc/socket/rdoc/TCPServer.html
 # https://stackoverflow.com/questions/806267/how-to-fire-and-forget-a-subprocess
@@ -15,8 +21,7 @@ module Jets
     PORT = 8080
 
     def run
-      $stdout.sync = true
-      Jets.boot # outside of child process for COW
+      Jets.boot(stringio: true) # outside of child process for COW
       Jets.eager_load!
 
       # INT - ^C
@@ -44,10 +49,11 @@ module Jets
       # child process
       server = TCPServer.new(8080) # Server bind to port 8080
       puts "Ruby server started on port #{PORT}" if ENV['FOREGROUND'] || ENV['JETS_DEBUG'] || ENV['C9_USER']
-      input_completed = false
+
       loop do
-        event, handler = nil, nil
         client = server.accept    # Wait for a client to connect
+
+        input_completed, event, handler = nil, nil, nil
         unless input_completed
           event = client.gets.strip # text
           # puts event # uncomment for debugging, Jets has changed stdout to stderr
@@ -60,9 +66,10 @@ module Jets
           prewarm_request(event) :
           standard_request(event, '{}', handler)
 
-        client.puts(result)
+        Jets::Booter.flush_output # flushing output as soon we dont need it anymore
+
+        client.puts('{"test": 1}')
         client.close
-        input_completed = false
       end
     end
 
@@ -90,4 +97,3 @@ module Jets
     end
   end
 end
-

data/lib/jets/version.rb

@@ -1,3 +1,3 @@
 module Jets
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jets
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-20 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor