functions_framework 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eca52587c3a84a8fdfc58792bc87fb6908e5bbf1c65b265b12ccdc1eb943848d
-  data.tar.gz: 2226f0ba38007a22bbd046093a9d726aadcb25feaf18a7c6b24d780b5bdfc749
+  metadata.gz: 7181bfabab004b16d032f16f2598fb80027422481c9ce5ee3c048f5331422d10
+  data.tar.gz: 73344235c945308d98a44bb7536bbc32d6fdb5b58ed0379696a09becdf2be016
 SHA512:
-  metadata.gz: '08d533e4c06749aeee4feb6988a775186a392a18b3c50a79bc93700b99c56ea6a16da7195c89afd44e4313770e620e3071a7d6207d568a3dd9aed4a9339da71d'
-  data.tar.gz: 1c145d4178b2d86bdde76c38340c3ea51f2b54bb9897304eb84ce1f3586467f7e205a4007d06a98dcfa8d78c5b8dbdb8afc919b8e0801bdf5c2420266e3b4dff
+  metadata.gz: 4edeb7e9b2fbd5ab9ee3d28f442336363c32ab2faf928b81738b5c82a3c6b16b8e9dd0983417427db4145930eaf12b1f0d709e638999edba01c55c3b5cbdcf97
+  data.tar.gz: ffe0f772f40ff8d8c1a74e8cf6f2e5adfa663513290f88b4c9ad119dfb91b7b0caa3887337bad1736eb556b8d5312b376606b266602069db32fd75973867fa06

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 1.1.0 (2022-01-17)
+
+* Increase default max thread pool size to 8.
+* Return 204 when a GET request is sent to an event function, to support health checks.
+* Flush stdout and stderr streams at the end of each request.
+* Format the error backtrace.
+
 ## 1.0.1 (2021-09-10)
 
 * FIXED: Update legacy event conversion to set the correct types for firebase database events

data/RELEASING.md

@@ -0,0 +1,78 @@
+# Releasing
+
+Releases are performed using tooling developed by Google's GitHub Automation
+team, and are partially automated, but can be controlled by maintainers.
+
+## The automated release pipeline
+
+Whenever a commit is pushed to the main branch with a
+[Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) message,
+the automated release pipeline will trigger.
+
+### Release pull requests
+
+The [release-please](https://github.com/googleapis/release-please) bot watches
+for commits that indicate a semantic change, normally either `feat:` or `fix:`,
+or any commit that includes a breaking change. When new commits are pushed,
+release-please will propose a new release whose version is based on the semver
+implication of the change: a patch release for a `fix:`, a minor release for a
+`feat:`, or a major release for a breaking change. This will appear in the form
+of a pull request, which will include the proposed new version, and a changelog
+entry.
+
+A maintainer can either:
+
+* Close the pull request to defer the release until more changes have been
+  committed.
+* Accept the release by merging the pull request, possibly after modifying the
+  changelog.
+
+Do NOT modify the version in the pull request. If you want to release a
+different version, see the next section on proposing releases manually.
+
+When merging a release pull request, make sure the `autorelease: pending` label
+remains applied. This is important for correct operation of the rest of the
+release pipeline.
+
+### Release scripts
+
+After a release pull request is merged, another bot will trigger the rest of
+the release pipeline. This bot runs every 15 minutes, so this process may be
+delayed a few minutes. Once it runs, it will do the following automatically:
+
+* Tag the release and create a GitHub release. This takes place in a kokoro
+  (internal Google) job. Once finished, it will switch the tag from
+  `autorelease: pending` to `autorelease: tagged`. If it seems to be
+  malfunctioning, you can find logs on the internal fusion dashboard under the
+  job `cloud-devrel/client-libraries/autorelease/tag`.
+* Build and push the gem to Rubygems, and build and push the documentation to
+  googleapis.dev. This takes place in a second kokoro job. Once finished, it
+  will switch the tag from `autorelease: tagged` to `autorelease: published`.
+  If this job seems to be malfunctioning, find the logs under the kokoro job
+  `cloud-devrel/ruby/functions-framework-ruby/release`.
+
+## Manually proposing a release
+
+If you want to propose a release out-of-band or customize the version number to
+use, you can use a command line tool to create a release pull request.
+
+### Prerequisites
+
+You need to install:
+
+* git version 2.22 or later
+* The gh cli (https://cli.github.com/)
+* The release-please npm module
+* The toys rubygem
+
+### Running the release proposal script
+
+Once the prerequisites are installed, run:
+
+    toys release please functions_framework:1.2.3
+
+(Replace `1.2.3` with the version to release.)
+
+This will open an appropriate release pull request. Then you can merge it
+(possibly after modifying the changelog) and the release pipeline will proceed
+as described above.

data/lib/functions_framework/server.rb

@@ -306,7 +306,7 @@ module FunctionsFramework
       # @return [Integer]
       #
       def max_threads
-        @max_threads || 1
+        @max_threads || 8
       end
 
       ##
@@ -352,7 +352,9 @@ module FunctionsFramework
         when ::CloudEvents::CloudEventsError
           cloud_events_error_response response
         when ::StandardError
-          error_response "#{response.class}: #{response.message}\n#{response.backtrace}\n"
+          message = "#{response.class}: #{response.message}"
+          message = [message, *response.backtrace].join "\n\t"
+          error_response message
         else
           error_response "Unexpected response type: #{response.class}"
         end
@@ -362,6 +364,10 @@ module FunctionsFramework
         string_response "Not found", 404
       end
 
+      def no_content_response
+        [204, [], []]
+      end
+
       def string_response string, status, content_type: nil
         string.force_encoding ::Encoding::ASCII_8BIT unless string.valid_encoding?
         if string.encoding == ::Encoding::ASCII_8BIT
@@ -387,6 +393,11 @@ module FunctionsFramework
         message = "Unexpected internal error" unless @config.show_error_details?
         string_response message, 500
       end
+
+      def flush_streams
+        $stdout.flush
+        $stderr.flush
+      end
     end
 
     ## @private
@@ -401,7 +412,7 @@ module FunctionsFramework
         return notfound_response if excluded_path? env
         response =
           begin
-            logger = env["rack.logger"] ||= @config.logger
+            logger = env[::Rack::RACK_LOGGER] ||= @config.logger
             request = ::Rack::Request.new env
             logger.info "FunctionsFramework: Handling HTTP #{request.request_method} request"
             @function.call request, globals: @globals, logger: logger
@@ -409,6 +420,8 @@ module FunctionsFramework
             e
           end
         interpret_response response
+      ensure
+        flush_streams
       end
     end
 
@@ -424,7 +437,8 @@ module FunctionsFramework
 
       def call env
         return notfound_response if excluded_path? env
-        logger = env["rack.logger"] ||= @config.logger
+        return no_content_response if env[::Rack::REQUEST_METHOD] == "GET"
+        logger = env[::Rack::RACK_LOGGER] ||= @config.logger
         event = decode_event env
         response =
           case event
@@ -438,6 +452,8 @@ module FunctionsFramework
             raise "Unexpected event type: #{event.class}"
           end
         interpret_response response
+      ensure
+        flush_streams
       end
 
       private
@@ -446,9 +462,8 @@ module FunctionsFramework
         begin
           @cloud_events.decode_event env
         rescue ::CloudEvents::NotCloudEventError
-          env["rack.input"].rewind rescue nil
-          @legacy_events.decode_rack_env(env) ||
-            raise(::CloudEvents::CloudEventsError, "Unrecognized event format")
+          env[::Rack::RACK_INPUT].rewind rescue nil
+          @legacy_events.decode_rack_env(env) || ::CloudEvents::CloudEventsError.new("Unrecognized event format")
         end
       rescue ::CloudEvents::CloudEventsError => e
         e

data/lib/functions_framework/testing.rb

@@ -335,7 +335,8 @@ module FunctionsFramework
           json = ::JSON.dump response
           string_response json, 200, content_type: "application/json"
         when ::StandardError
-          message = "#{response.class}: #{response.message}\n#{response.backtrace}\n"
+          message = "#{response.class}: #{response.message}"
+          message = [message, *response.backtrace].join "\n\t"
           string_response message, 500
         else
           raise "Unexpected response type: #{response.inspect}"

data/lib/functions_framework/version.rb

@@ -17,5 +17,5 @@ module FunctionsFramework
   # Version of the Ruby Functions Framework
   # @return [String]
   #
-  VERSION = "1.0.1".freeze
+  VERSION = "1.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: functions_framework
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-13 00:00:00.000000000 Z
+date: 2022-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cloud_events
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -80,6 +80,7 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- RELEASING.md
 - bin/functions-framework
 - bin/functions-framework-ruby
 - docs/deploying-functions.md
@@ -99,10 +100,10 @@ homepage: https://github.com/GoogleCloudPlatform/functions-framework-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v1.0.1/file.CHANGELOG.html
+  changelog_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v1.1.0/file.CHANGELOG.html
   source_code_uri: https://github.com/GoogleCloudPlatform/functions-framework-ruby
   bug_tracker_uri: https://github.com/GoogleCloudPlatform/functions-framework-ruby/issues
-  documentation_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v1.0.1
+  documentation_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v1.1.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -118,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Functions Framework for Ruby