fix: Updated the Pub/Sub event conversion logic to better align to Eventarc (#105)

Author: matthewrobertson

.github/workflows/conformance.yml

@@ -33,7 +33,7 @@ jobs:
         useBuildpacks: false
         cmd: "'bundle exec functions-framework-ruby --source test/conformance/app.rb --target http_func --signature-type http'"
     - name: Run CloudEvent conformance tests
-      uses: GoogleCloudPlatform/functions-framework-conformance/[email protected].9
+      uses: GoogleCloudPlatform/functions-framework-conformance/[email protected].11
       with:
         functionType: 'cloudevent'
         useBuildpacks: false

lib/functions_framework/legacy_event_converter.rb

@@ -117,7 +117,7 @@ def construct_cloud_event context, data
       source, subject = convert_source context[:service], context[:resource]
       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,
@@ -137,9 +137,12 @@ def convert_source service, resource
       ["//#{service}/#{match[1]}", match[2]]
     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"

test/test_legacy_event_converter.rb

@@ -36,6 +36,9 @@ def load_legacy_event filename, url_path: nil, encoding: "utf-8"
     assert_equal "2020-05-18T12:13:19+00:00", event.time.rfc3339
     assert_equal "value1", event.data["message"]["attributes"]["attribute1"]
     assert_equal "VGhpcyBpcyBhIHNhbXBsZSBtZXNzYWdl", event.data["message"]["data"]
+    assert_equal "1215011316659232", event.data["message"]["messageId"]
+    assert_equal "2020-05-18T12:13:19.209Z", event.data["message"]["publishTime"]
+    assert_nil event.data["subscription"]
   end
 
   it "converts legacy_storage_change.json" do
@@ -59,6 +62,8 @@ def load_legacy_event filename, url_path: nil, encoding: "utf-8"
     assert_equal "2020-05-06T07:33:34+00:00", event.time.rfc3339
     assert_equal "attr1-value", event.data["message"]["attributes"]["attr1"]
     assert_equal "dGVzdCBtZXNzYWdlIDM=", event.data["message"]["data"]
+    assert_equal "1144231683168617", event.data["message"]["messageId"]
+    assert_equal "2020-05-06T07:33:34.556Z", event.data["message"]["publishTime"]
   end
 
   it "converts pubsub_utf8.json" do
@@ -71,6 +76,8 @@ def load_legacy_event filename, url_path: nil, encoding: "utf-8"
     assert_equal "2020-05-06T07:33:34+00:00", event.time.rfc3339
     assert_equal "あああ", event.data["message"]["attributes"]["attr1"]
     assert_equal "dGVzdCBtZXNzYWdlIDM=", event.data["message"]["data"]
+    assert_equal "1144231683168617", event.data["message"]["messageId"]
+    assert_equal "2020-05-06T07:33:34.556Z", event.data["message"]["publishTime"]
   end
 
   it "converts pubsub_binary.json" do
@@ -82,6 +89,8 @@ def load_legacy_event filename, url_path: nil, encoding: "utf-8"
     assert_nil event.subject
     assert_equal "2020-05-06T07:33:34+00:00", event.time.rfc3339
     assert_equal "AQIDBA==", event.data["message"]["data"]
+    assert_equal "1144231683168617", event.data["message"]["messageId"]
+    assert_equal "2020-05-06T07:33:34.556Z", event.data["message"]["publishTime"]
   end
 
   it "converts raw_pubsub.json" do
@@ -94,6 +103,9 @@ def load_legacy_event filename, url_path: nil, encoding: "utf-8"
     assert_in_delta event.time.to_time.to_f, Time.now.to_f, 1.0
     assert_equal "123", event.data["message"]["attributes"]["test"]
     assert_equal "eyJmb28iOiJiYXIifQ==", event.data["message"]["data"]
+    assert_equal "1215011316659232", event.data["message"]["messageId"]
+    timestamp = event.time.to_time.utc.strftime "%Y-%m-%dT%H:%M:%S.%6NZ"
+    assert_equal timestamp, event.data["message"]["publishTime"]
   end
 
   it "converts raw_pubsub.json with path" do
@@ -106,6 +118,9 @@ def load_legacy_event filename, url_path: nil, encoding: "utf-8"
     assert_in_delta event.time.to_time.to_f, Time.now.to_f, 1.0
     assert_equal "123", event.data["message"]["attributes"]["test"]
     assert_equal "eyJmb28iOiJiYXIifQ==", event.data["message"]["data"]
+    assert_equal "1215011316659232", event.data["message"]["messageId"]
+    timestamp = event.time.to_time.utc.strftime "%Y-%m-%dT%H:%M:%S.%6NZ"
+    assert_equal timestamp, event.data["message"]["publishTime"]
   end
 
   it "converts storage.json" do