functions_framework 0.9.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a4d1e19c5565de4604964e48ff818b05460b2211ef2c8cfbd100bd572d802d7
-  data.tar.gz: 380d987acf157075cfe7fca5bf038404eb800f48b80614ce9781f44cbd6de764
+  metadata.gz: eca52587c3a84a8fdfc58792bc87fb6908e5bbf1c65b265b12ccdc1eb943848d
+  data.tar.gz: 2226f0ba38007a22bbd046093a9d726aadcb25feaf18a7c6b24d780b5bdfc749
 SHA512:
-  metadata.gz: c76cb765863334411e7ab3bd448912fabc14c7725ae66465426ee996b05557d44653f64d47c98eb429d077f0df558b550b228a3fce014dd5aa9e02e4933cbc62
-  data.tar.gz: af8d74d419c75dc8f850fa989d48780a26e2639045ff945d4b0a1cd29fa0085d3a82d058db6e49ed9c9f2c2855b3bc495a44ab530e129a846b24c111c76f79f2
+  metadata.gz: '08d533e4c06749aeee4feb6988a775186a392a18b3c50a79bc93700b99c56ea6a16da7195c89afd44e4313770e620e3071a7d6207d568a3dd9aed4a9339da71d'
+  data.tar.gz: 1c145d4178b2d86bdde76c38340c3ea51f2b54bb9897304eb84ce1f3586467f7e205a4007d06a98dcfa8d78c5b8dbdb8afc919b8e0801bdf5c2420266e3b4dff

data/CHANGELOG.md

@@ -1,21 +1,41 @@
 # Changelog
 
-### v0.9.0 / 2021-03-18
+## 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
 
 * 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.
@@ -29,33 +49,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.
@@ -66,21 +86,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:
 
@@ -99,11 +119,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.9"
+gem "functions_framework", "~> 1.0"
 ```
 
 Create a file called `app.rb` and include the following code. This defines a

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.9"
+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.9"
+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.9"
+gem "functions_framework", "~> 1.0"
 ```
 
 ```ruby

data/lib/functions_framework/legacy_event_converter.rb

@@ -27,10 +27,11 @@ module FunctionsFramework
     # @return [nil] if the event format was not recognized.
     #
     def decode_rack_env env
-      content_type = ::CloudEvents::ContentType.new env["CONTENT_TYPE"]
+      content_type = ::CloudEvents::ContentType.new env["CONTENT_TYPE"], default_charset: "utf-8"
       return nil unless content_type.media_type == "application" && content_type.subtype_base == "json"
       input = read_input_json env["rack.input"], content_type.charset
       return nil unless input
+      input = convert_raw_pubsub_event input, env if raw_pubsub_payload? input
       context = normalized_context input
       return nil unless context
       construct_cloud_event context, input["data"]
@@ -40,7 +41,7 @@ module FunctionsFramework
 
     def read_input_json input, charset
       input = input.read if input.respond_to? :read
-      input = input.encode charset if charset
+      input.force_encoding charset if charset
       content = ::JSON.parse input
       content = nil unless content.is_a? ::Hash
       content
@@ -48,14 +49,46 @@ module FunctionsFramework
       nil
     end
 
+    def raw_pubsub_payload? input
+      return false if input.include?("context") || !input.include?("subscription")
+      message = input["message"]
+      message.is_a?(::Hash) && message.include?("data") && message.include?("messageId")
+    end
+
+    def convert_raw_pubsub_event input, env
+      message = input["message"]
+      path = "#{env['SCRIPT_NAME']}#{env['PATH_INFO']}"
+      path_match = %r{projects/[^/?]+/topics/[^/?]+}.match path
+      topic = path_match ? path_match[0] : "UNKNOWN_PUBSUB_TOPIC"
+      timestamp = message["publishTime"] || ::Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S.%6NZ")
+      {
+        "context" => {
+          "eventId" => message["messageId"],
+          "timestamp" => timestamp,
+          "eventType" => "google.pubsub.topic.publish",
+          "resource" => {
+            "service" => "pubsub.googleapis.com",
+            "type" => "type.googleapis.com/google.pubsub.v1.PubsubMessage",
+            "name" => topic
+          }
+        },
+        "data" => {
+          "@type" => "type.googleapis.com/google.pubsub.v1.PubsubMessage",
+          "data" => message["data"],
+          "attributes" => message["attributes"]
+        }
+      }
+    end
+
     def normalized_context input
       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
@@ -82,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,
@@ -97,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"
@@ -148,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

@@ -346,9 +346,9 @@ module FunctionsFramework
         when ::Rack::Response
           response.finish
         when ::String
-          string_response response, "text/plain", 200
+          string_response response, 200
         when ::Hash
-          string_response ::JSON.dump(response), "application/json", 200
+          string_response ::JSON.dump(response), 200, content_type: "application/json"
         when ::CloudEvents::CloudEventsError
           cloud_events_error_response response
         when ::StandardError
@@ -359,10 +359,17 @@ module FunctionsFramework
       end
 
       def notfound_response
-        string_response "Not found", "text/plain", 404
+        string_response "Not found", 404
       end
 
-      def string_response string, content_type, status
+      def string_response string, status, content_type: nil
+        string.force_encoding ::Encoding::ASCII_8BIT unless string.valid_encoding?
+        if string.encoding == ::Encoding::ASCII_8BIT
+          content_type ||= "application/octet-stream"
+        else
+          content_type ||= "text/plain"
+          content_type = "#{content_type}; charset=#{string.encoding.name.downcase}"
+        end
         headers = {
           "Content-Type"   => content_type,
           "Content-Length" => string.bytesize
@@ -372,13 +379,13 @@ module FunctionsFramework
 
       def cloud_events_error_response error
         @config.logger.warn error
-        string_response "#{error.class}: #{error.message}", "text/plain", 400
+        string_response "#{error.class}: #{error.message}", 400
       end
 
       def error_response message
         @config.logger.error message
         message = "Unexpected internal error" unless @config.show_error_details?
-        string_response message, "text/plain", 500
+        string_response message, 500
       end
     end
 
@@ -424,7 +431,7 @@ module FunctionsFramework
           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
@@ -436,9 +443,13 @@ module FunctionsFramework
       private
 
       def decode_event env
-        @cloud_events.decode_rack_env(env) ||
+        begin
+          @cloud_events.decode_event env
+        rescue ::CloudEvents::NotCloudEventError
+          env["rack.input"].rewind rescue nil
           @legacy_events.decode_rack_env(env) ||
-          raise(::CloudEvents::HttpContentError, "Unrecognized event format")
+            raise(::CloudEvents::CloudEventsError, "Unrecognized event format")
+        end
       rescue ::CloudEvents::CloudEventsError => e
         e
       end

data/lib/functions_framework/testing.rb

@@ -330,20 +330,27 @@ module FunctionsFramework
         when ::Array
           ::Rack::Response.new response[2], response[0], response[1]
         when ::String
-          string_response response, "text/plain", 200
+          string_response response, 200
         when ::Hash
           json = ::JSON.dump response
-          string_response json, "application/json", 200
+          string_response json, 200, content_type: "application/json"
         when ::StandardError
           message = "#{response.class}: #{response.message}\n#{response.backtrace}\n"
-          string_response message, "text/plain", 500
+          string_response message, 500
         else
           raise "Unexpected response type: #{response.inspect}"
         end
       end
 
       ## @private
-      def string_response string, content_type, status
+      def string_response string, status, content_type: nil
+        string.force_encoding ::Encoding::ASCII_8BIT unless string.valid_encoding?
+        if string.encoding == ::Encoding::ASCII_8BIT
+          content_type ||= "application/octet-stream"
+        else
+          content_type ||= "text/plain"
+          content_type = "#{content_type}; charset=#{string.encoding.name.downcase}"
+        end
         headers = {
           "Content-Type"   => content_type,
           "Content-Length" => string.bytesize

data/lib/functions_framework/version.rb

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

metadata

@@ -1,43 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: functions_framework
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cloud_events
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: 6.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: 6.a
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -87,10 +99,10 @@ homepage: https://github.com/GoogleCloudPlatform/functions-framework-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v0.9.0/file.CHANGELOG.html
+  changelog_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v1.0.1/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.9.0
+  documentation_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v1.0.1
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -106,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: Functions Framework for Ruby