functions_framework 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: feaa072a9d05a5a0308e4721d338aea1d5bdcb65d257f74210073518d3f21735
-  data.tar.gz: ef5d554a4ebf4dcb5e5d00b88f17ac36bd151d3b061038a35a26ed520dcd02b7
+  metadata.gz: 7f26316991786d4688dc35bab52d91d7df30c11fa573b5e5e9678b095d3e2047
+  data.tar.gz: 9b900e5156d42e4acdae4a8312bc25b866202f738f84ed9e264815fb2635ef42
 SHA512:
-  metadata.gz: 699655e4efcd96b4fa46ccf2017f38d76848b2827115909b599bd722d2eb0d447da1fb3bc0323f825bf0b69024f1a947eaf969e95b205d90e6393babe2b8c15e
-  data.tar.gz: 297c2eda593a1b995c233b7ff89d92e11c7921322bceeb14eac71eb351bf04d0956e6c0de18e91137884ace3fc6f0a4422c2e3b79d7598fdc0ab567f93bfe638
+  metadata.gz: 75180c4a931148fff3490084a4a43bacbcc65089812a18b397f9781f4e5e0899db5acde266f27bbf25f325c23d18c987abb4a1671125cb8db049b77da4b05a59
+  data.tar.gz: f7f95a82b95ab9e7b6f4f4dd16f455dac9f3ea71549401b6bc6b781b6b011741f4e9b59ef97fb444c2b0fbec718eb0f8f92895f1a2a7adbd8f404e590c22d124

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 # Changelog
 
-### v1.0.0 / 2021-07-07
+### 1.2.0 (2022-08-25)
+
+* Update minimum Ruby version to 2.6
+* Increase default max thread pool size to 16
+
+### 1.1.0 (2022-01-18)
+
+* 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
+
+### 1.0.0 (2021-07-07)
 
 * Bumped the version to 1.0.
 * Removed the "preview" notices for Google Cloud Functions since the Ruby runtime is now GA.

data/README.md

@@ -42,14 +42,14 @@ requiring an HTTP server or complicated request handling logic.
 
 ## Supported Ruby versions
 
-This library is supported on Ruby 2.5+.
+This library is supported on Ruby 2.6+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-in security maintenance, and not end of life. Currently, this means Ruby 2.5
-and later. Older versions of Ruby _may_ still work, but are unsupported and not
-recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
-about the Ruby support schedule.
+in security maintenance, and not end of life. Older versions of Ruby _may_
+still work, but are unsupported and not recommended. See
+https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
+support schedule.
 
 ## Quickstart
 

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/docs/deploying-functions.md

@@ -147,8 +147,8 @@ command may ask you for permission to enable the Cloud Build API for the project
 if it isn't already enabled.
 
 Because you provide your own Docker image when deploying to Cloud Run, you can
-use any version of Ruby supported by the Functions Framework, from 2.5 through
-3.0.
+use any version of Ruby supported by the Functions Framework, from 2.6 through
+3.1.
 
 ### Deploying an image to Cloud Run
 

data/docs/overview.md

@@ -46,14 +46,14 @@ requiring an HTTP server or complicated request handling logic.
 
 ## Supported Ruby versions
 
-This library is supported on Ruby 2.5+.
+This library is supported on Ruby 2.6+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-in security maintenance, and not end of life. Currently, this means Ruby 2.5
-and later. Older versions of Ruby _may_ still work, but are unsupported and not
-recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
-about the Ruby support schedule.
+in security maintenance, and not end of life. Older versions of Ruby _may_
+still work, but are unsupported and not recommended. See
+https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
+support schedule.
 
 ## Quickstart
 

data/lib/functions_framework/cli.rb

@@ -85,8 +85,8 @@ module FunctionsFramework
           @source = val
         end
         op.on "--signature-type TYPE",
-              "Asserts that the function has the given signature type." \
-              " Supported values are 'http' and 'cloudevent'." do |val|
+              "Asserts that the function has the given signature type. " \
+              "Supported values are 'http' and 'cloudevent'." do |val|
           @signature_type = val
         end
         op.on "-p", "--port PORT", "Set the port to listen to (defaults to 8080)" do |val|
@@ -196,8 +196,8 @@ module FunctionsFramework
       function = ::FunctionsFramework.global_registry[@target]
       raise "Undefined function: #{@target.inspect}" if function.nil?
       unless @signature_type.nil? ||
-             @signature_type == "http" && function.type == :http ||
-             ["cloudevent", "event"].include?(@signature_type) && function.type == :cloud_event
+             (@signature_type == "http" && function.type == :http) ||
+             (["cloudevent", "event"].include?(@signature_type) && function.type == :cloud_event)
         raise "Function #{@target.inspect} does not match type #{@signature_type}"
       end
       function

data/lib/functions_framework/legacy_event_converter.rb

@@ -200,10 +200,10 @@ module FunctionsFramework
       "providers/firebase.auth/eventTypes/user.create"           => "google.firebase.auth.user.v1.created",
       "providers/firebase.auth/eventTypes/user.delete"           => "google.firebase.auth.user.v1.deleted",
       "providers/google.firebase.analytics/eventTypes/event.log" => "google.firebase.analytics.log.v1.written",
-      "providers/google.firebase.database/eventTypes/ref.create" => "google.firebase.database.document.v1.created",
-      "providers/google.firebase.database/eventTypes/ref.write"  => "google.firebase.database.document.v1.written",
-      "providers/google.firebase.database/eventTypes/ref.update" => "google.firebase.database.document.v1.updated",
-      "providers/google.firebase.database/eventTypes/ref.delete" => "google.firebase.database.document.v1.deleted",
+      "providers/google.firebase.database/eventTypes/ref.create" => "google.firebase.database.ref.v1.created",
+      "providers/google.firebase.database/eventTypes/ref.write"  => "google.firebase.database.ref.v1.written",
+      "providers/google.firebase.database/eventTypes/ref.update" => "google.firebase.database.ref.v1.updated",
+      "providers/google.firebase.database/eventTypes/ref.delete" => "google.firebase.database.ref.v1.deleted",
       "providers/cloud.storage/eventTypes/object.change"         => "google.cloud.storage.object.v1.finalized"
     }.freeze
 

data/lib/functions_framework/server.rb

@@ -87,8 +87,8 @@ module FunctionsFramework
           @server.max_threads = @config.max_threads
           @server.leak_stack_on_error = @config.show_error_details?
           @server.binder.add_tcp_listener @config.bind_addr, @config.port
-          @config.logger.info "FunctionsFramework: Serving function #{@function.name.inspect}" \
-                              " on port #{@config.port}..."
+          @config.logger.info "FunctionsFramework: Serving function #{@function.name.inspect} " \
+                              "on port #{@config.port}..."
           @server.run true
         end
       end
@@ -306,7 +306,7 @@ module FunctionsFramework
       # @return [Integer]
       #
       def max_threads
-        @max_threads || 1
+        @max_threads || 16
       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.0".freeze
+  VERSION = "1.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: functions_framework
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2022-08-25 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.5.1
+        version: 0.7.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        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.0/file.CHANGELOG.html
+  changelog_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v1.2.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.0
+  documentation_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v1.2.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -111,14 +112,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: Functions Framework for Ruby