functions_framework 0.10.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aefd222f82f6f3b6e54e5a9fc512e20f3cad4ff9ac5dfe3ee454efbc4bf88f70
-  data.tar.gz: ba675682be6f79c8c799336c92551955ed6d2f24bcfa5ee17373cf75151897c1
+  metadata.gz: 7181bfabab004b16d032f16f2598fb80027422481c9ce5ee3c048f5331422d10
+  data.tar.gz: 73344235c945308d98a44bb7536bbc32d6fdb5b58ed0379696a09becdf2be016
 SHA512:
-  metadata.gz: 937e27e64ad65f0f4fd9888c6bc94fcace25a39e68834f37c04d9aecb407b8fa0dc5ef35f8ebc1d78e0134914241e42cc92714f9d4236dee77daae5259cd55f1
-  data.tar.gz: 9eb7d77db1a3faae5ff91cc3c365383b96a02bbc78b7e733e9a85a8752decaf5e97b93ec78665af936840f56d89de7f542439adedef9c4a0b73912c4cc9a5748
+  metadata.gz: 4edeb7e9b2fbd5ab9ee3d28f442336363c32ab2faf928b81738b5c82a3c6b16b8e9dd0983417427db4145930eaf12b1f0d709e638999edba01c55c3b5cbdcf97
+  data.tar.gz: ffe0f772f40ff8d8c1a74e8cf6f2e5adfa663513290f88b4c9ad119dfb91b7b0caa3887337bad1736eb556b8d5312b376606b266602069db32fd75973867fa06

data/CHANGELOG.md

@@ -1,27 +1,48 @@
 # Changelog
 
-### v0.10.0 / 2021-06-01
+## 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
+
+## 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.
+
+## v0.11.0 / 2021-06-28
+
+* UPDATED: Update CloudEvents dependency to 0.5 to get fixes for JSON formatting cases
+* FIXED: Updated Pub/Sub and Firebase event conversion logic to better align to Eventarc
+
+## v0.10.0 / 2021-06-01
 
 * ADDED: Support raw pubsub events sent by the pubsub emulator
 * FIXED: Set proper response content-type charset when a function returns a string (plain text) or hash (JSON)
 * FIXED: Properly handle conversion of non-ascii characters in legacy event strings
 
-### v0.9.0 / 2021-03-18
+## v0.9.0 / 2021-03-18
 
 * BREAKING CHANGE: Servers are configured as single-threaded in production by default, matching the current behavior of Google Cloud Functions.
 * FIXED: Fixed conversion of Firebase events to CloudEvents to conform to the specs used by Cloud Functions and Cloud Run.
 * FIXED: Fixed an error when reading a global set to a Minitest::Mock. This will make it easier to write tests that use mocks for global resources.
 
-### v0.8.0 / 2021-03-02
+## v0.8.0 / 2021-03-02
 
 * ADDED: Support for lazily-initialized globals
 
-### v0.7.1 / 2021-01-26
+## v0.7.1 / 2021-01-26
 
 * DOCS: Fixed several errors in the writing-functions doc samples
 * DOCS: Updated documentation to note public release of GCF support 
 
-### v0.7.0 / 2020-09-25
+## v0.7.0 / 2020-09-25
 
 * Now requires Ruby 2.5 or later.
 * BREAKING CHANGE: Renamed "context" hash to "globals" and made it read-only for normal functions.
@@ -35,33 +56,33 @@
 * DOCS: Expanded documentation on initialization, execution context, and shared resources.
 * DEPRECATED: The functions-framework executable is deprecated. Use functions-framework-ruby instead.
 
-### v0.6.0 / 2020-09-17
+## v0.6.0 / 2020-09-17
 
 * ADDED: You can use the --version flag to print the framework version
 * ADDED: You can use the --verify flag to verify that a given function is defined
 * ADDED: You can now define blocks that are executed at server startup
 
-### v0.5.2 / 2020-09-06
+## v0.5.2 / 2020-09-06
 
 * FIXED: Use global $stderr rather than STDERR for logger 
 * DOCS: Fix instructions for deployment to Google Cloud Functions 
 
-### v0.5.1 / 2020-07-20
+## v0.5.1 / 2020-07-20
 
 * Updated some documentation links. No functional changes.
 
-### v0.5.0 / 2020-07-09
+## v0.5.0 / 2020-07-09
 
 * Removed embedded CloudEvents classes and added the official CloudEvents SDK as a dependency. A `FunctionsFramework::CloudEvents` alias provides backward compatibility.
 
-### v0.4.1 / 2020-07-08
+## v0.4.1 / 2020-07-08
 
 * Fixed unsupported signal error on Windows.
 * Fixed several edge case errors in legacy event conversion.
 * Generated Content-Type headers now properly quote param values if needed.
 * Minor documentation updates.
 
-### v0.4.0 / 2020-06-29
+## v0.4.0 / 2020-06-29
 
 * Dropped the legacy and largely unsupported `:event` function type. All event functions should be of type `:cloud_event`.
 * Define the object context for function execution, and include an extensible context helper.
@@ -72,21 +93,21 @@
 * Removed redundant `_string` accessors from event classes since raw forms are already available via `[]`.
 * A variety of corrections to event-related class documentation.
 
-### v0.3.1 / 2020-06-27
+## v0.3.1 / 2020-06-27
 
 * Fixed crash when using "return" directly in a function block.
 * Added a more flexible request generation helper in the testing module.
 * Fixed several typos in the documentation.
 
-### v0.3.0 / 2020-06-26
+## v0.3.0 / 2020-06-26
 
 * Updated the CloudEvent data format for converted pubsub events to conform to Cloud Run's conversion.
 
-### v0.2.1 / 2020-06-25
+## v0.2.1 / 2020-06-25
 
 * The `--signature-type` check recognizes the legacy `event` type for `:cloud_event` functions.
 
-### v0.2.0 / 2020-06-24
+## v0.2.0 / 2020-06-24
 
 Significant changes:
 
@@ -105,11 +126,11 @@ Minor changes:
 * Renamed a few undocumented environment variables, and added support for a logging level environment variable. All CLI flags now have associated environment variables.
 * Several fixes to the example code, and added a new Sinatra example.
 
-### v0.1.1 / 2020-02-27
+## v0.1.1 / 2020-02-27
 
 * Server returns 404 when receiving a /favicon.ico or /robots.txt request.
 * Correct a rack constant name in Testing#make_post_request
 
-### v0.1.0 / 2020-01-30
+## v0.1.0 / 2020-01-30
 
 * Initial release

data/README.md

@@ -4,7 +4,7 @@ An open source framework for writing lightweight, portable Ruby functions that
 run in a serverless environment. Functions written to this Framework will run
 in many different environments, including:
 
- *  [Google Cloud Functions](https://cloud.google.com/functions) *(public preview)*
+ *  [Google Cloud Functions](https://cloud.google.com/functions)
  *  [Google Cloud Run](https://cloud.google.com/run)
  *  Any other [Knative](https://github.com/knative)-based environment
  *  Your local development machine
@@ -60,7 +60,7 @@ Create a `Gemfile` listing the Functions Framework as a dependency:
 ```ruby
 # Gemfile
 source "https://rubygems.org"
-gem "functions_framework", "~> 0.10"
+gem "functions_framework", "~> 1.0"
 ```
 
 Create a file called `app.rb` and include the following code. This defines a

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/overview.md

@@ -8,7 +8,7 @@ The Functions Framework is an open source framework for writing lightweight,
 portable Ruby functions that run in a serverless environment. Functions written
 to this Framework will run in many different environments, including:
 
- *  [Google Cloud Functions](https://cloud.google.com/functions) *(public preview)*
+ *  [Google Cloud Functions](https://cloud.google.com/functions)
  *  [Google Cloud Run](https://cloud.google.com/run)
  *  Any other [Knative](https://github.com/knative)-based environment
  *  Your local development machine
@@ -64,7 +64,7 @@ Create a `Gemfile` listing the Functions Framework as a dependency:
 ```ruby
 # Gemfile
 source "https://rubygems.org"
-gem "functions_framework", "~> 0.10"
+gem "functions_framework", "~> 1.0"
 ```
 
 Create a file called `app.rb` and include the following code. This defines a

data/docs/writing-functions.md

@@ -111,7 +111,7 @@ dependency on Sinatra in your `Gemfile`:
 
 ```ruby
 source "https://rubygems.org"
-gem "functions_framework", "~> 0.10"
+gem "functions_framework", "~> 1.0"
 gem "sinatra", "~> 2.0"
 ```
 
@@ -152,7 +152,7 @@ information about it:
 require "functions_framework"
 
 FunctionsFramework.cloud_event "hello" do |event|
-  FunctionsFramework.logger.info "I received an event of type #{event.type}!"
+  logger.info "I received an event of type #{event.type}!"
 end
 ```
 
@@ -470,7 +470,7 @@ Following is a typical layout for a Functions Framework based project.
 ```ruby
 # Gemfile
 source "https://rubygems.org"
-gem "functions_framework", "~> 0.10"
+gem "functions_framework", "~> 1.0"
 ```
 
 ```ruby

data/lib/functions_framework/legacy_event_converter.rb

@@ -84,10 +84,11 @@ module FunctionsFramework
       id = normalized_context_field input, "eventId"
       timestamp = normalized_context_field input, "timestamp"
       type = normalized_context_field input, "eventType"
+      domain = normalized_context_field input, "domain"
       service, resource = analyze_resource normalized_context_field input, "resource"
       service ||= service_from_type type
       return nil unless id && timestamp && type && service && resource
-      { id: id, timestamp: timestamp, type: type, service: service, resource: resource }
+      { id: id, timestamp: timestamp, type: type, service: service, resource: resource, domain: domain }
     end
 
     def normalized_context_field input, field
@@ -114,10 +115,10 @@ module FunctionsFramework
     end
 
     def construct_cloud_event context, data
-      source, subject = convert_source context[:service], context[:resource]
+      source, subject = convert_source context[:service], context[:resource], context[:domain]
       type = LEGACY_TYPE_TO_CE_TYPE[context[:type]]
       return nil unless type && source
-      ce_data, data_subject = convert_data context[:service], data
+      ce_data, data_subject = convert_data context, data
       content_type = "application/json"
       ::CloudEvents::Event.new id:                context[:id],
                                source:            source,
@@ -129,17 +130,36 @@ module FunctionsFramework
                                time:              context[:timestamp]
     end
 
-    def convert_source service, resource
+    def convert_source service, resource, domain
       return ["//#{service}/#{resource}", nil] unless CE_SERVICE_TO_RESOURCE_RE.key? service
 
       match = CE_SERVICE_TO_RESOURCE_RE[service].match resource
       return [nil, nil] unless match
-      ["//#{service}/#{match[1]}", match[2]]
+      resource_fragment = match[1]
+      subject = match[2]
+
+      if service == "firebasedatabase.googleapis.com"
+        location =
+          case domain
+          when "firebaseio.com"
+            "us-central1"
+          when /^([\w-]+)\./
+            Regexp.last_match[1]
+          else
+            return [nil, nil]
+          end
+        ["//#{service}/projects/_/locations/#{location}/#{resource_fragment}", subject]
+      else
+        ["//#{service}/#{resource_fragment}", subject]
+      end
     end
 
-    def convert_data service, data
+    def convert_data context, data
+      service = context[:service]
       case service
       when "pubsub.googleapis.com"
+        data["messageId"] = context[:id]
+        data["publishTime"] = context[:timestamp]
         [{ "message" => data }, nil]
       when "firebaseauth.googleapis.com"
         if data.key? "metadata"
@@ -180,16 +200,16 @@ 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
 
     CE_SERVICE_TO_RESOURCE_RE = {
       "firebase.googleapis.com"         => %r{^(projects/[^/]+)/(events/[^/]+)$},
-      "firebasedatabase.googleapis.com" => %r{^(projects/_/instances/[^/]+)/(refs/.+)$},
+      "firebasedatabase.googleapis.com" => %r{^projects/_/(instances/[^/]+)/(refs/.+)$},
       "firestore.googleapis.com"        => %r{^(projects/[^/]+/databases/\(default\))/(documents/.+)$},
       "storage.googleapis.com"          => %r{^(projects/[^/]+/buckets/[^/]+)/([^#]+)(?:#.*)?$}
     }.freeze

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,28 +437,34 @@ 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
           when ::CloudEvents::Event
             handle_cloud_event event, logger
           when ::Array
-            ::CloudEvents::HttpContentError.new "Batched CloudEvents are not supported"
+            ::CloudEvents::CloudEventsError.new "Batched CloudEvents are not supported"
           when ::CloudEvents::CloudEventsError
             event
           else
             raise "Unexpected event type: #{event.class}"
           end
         interpret_response response
+      ensure
+        flush_streams
       end
 
       private
 
       def decode_event env
-        @cloud_events.decode_rack_env(env) ||
-          @legacy_events.decode_rack_env(env) ||
-          raise(::CloudEvents::HttpContentError, "Unrecognized event format")
+        begin
+          @cloud_events.decode_event env
+        rescue ::CloudEvents::NotCloudEventError
+          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
       end

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 = "0.10.0".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: 0.10.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-01 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.4'
+        version: 0.7.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        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/v0.10.0/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/v0.10.0
+  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.1.6
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Functions Framework for Ruby