proto_service_mesh 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb343f9b59bc8db10b06a8466222d6a808477cc0753480a83384c940a9e9696b
-  data.tar.gz: cf701b106b97be15a829e464010985bd58c6252ccbd45ca6acff91a0c1621593
+  metadata.gz: b3837c53424bc2b59a2808b6586c056dba67b76ff34e4871adfad3978fe9a668
+  data.tar.gz: 62dd2ab469307cf2a40e0060cdaede23c1c3e4f397e5c4d9cc4991e441a1f2d9
 SHA512:
-  metadata.gz: a3360b9dea587ed75a43062f8f5664bdb5fe7d81cbe74763c113c59f566eb85cfde7dc515b69d22be1b8f65212958010f97244ce2707ae9c7a280d64d6a3650b
-  data.tar.gz: 93641536186e764ac6e48bc0f0051b1b1dfc04cf4620d68a3f546289a9e2e630451bbc53a57081ccd834f4a3baf47d7243e186bc98417af3203cec6798a2a334
+  metadata.gz: e8552e6c52b9d1cb9f5e2e6d3b99f541659fe5f7bc29bb2e855da3e3e2c88b42c83b5147c068897a7449abee61d6a178a31be29a3e681b4b48865cfaa02a509d
+  data.tar.gz: 8982b84372dcc2e2a4ccd8b96e6f31ebcf89cde3590866088d5c4a1d403a9b7d232924d2445e0c56bf3b6b688ca540dccb25191338a95eebf31f97a3cc47b9a2

data/lib/proto_service_mesh/rpc_client.rb

@@ -28,15 +28,19 @@ module ProtoServiceMesh
 
     # Sends +request+ to a route and returns the decoded response, whose
     # mesh_metadata is the reply's metadata without keys that start with
-    # OPTION_PREFIX. Raises MeshError for a reply carrying Grpc-Status, or
-    # INTERNAL when either payload does not decode; either error's
-    # mesh_metadata is the same reply metadata.
+    # OPTION_PREFIX. Raises MeshError for a reply carrying Mesh-Status, or
+    # Grpc-Status when the reply has no Mesh-Status, or INTERNAL when either
+    # payload does not decode; either error's mesh_metadata is the same reply
+    # metadata. A reply that carries Grpc-Status or Content-Type without its
+    # Mesh- replacement comes from an older version, and the first such reply
+    # on the target writes a warning.
     def self.request(rpc, request)
       message, options = outbound(rpc, request)
       reply = client_for(rpc.target).request(message, options)
       reply_metadata = Wire.without_options(reply.metadata)
+      Wire.legacy_content_type?(rpc.target, reply.metadata)
       begin
-        if reply_metadata.key?(Wire::GRPC_STATUS_KEY)
+        if reply_metadata.key?(Wire::MESH_STATUS_KEY) || Wire.legacy_status?(rpc.target, reply.metadata)
           raise MeshError.from_proto(decode(Google::Rpc::Status, reply.payload))
         end
 

data/lib/proto_service_mesh/rpc_service.rb

@@ -6,7 +6,9 @@ module ProtoServiceMesh
   # serves, taking the decoded request, whose mesh_metadata is the inbound
   # message metadata. A route method returns the response; the response's
   # mesh_metadata, without keys that start with OPTION_PREFIX, is the reply's
-  # metadata. The same holds for a raised MeshError.
+  # metadata. The same holds for a raised MeshError. A request that carries
+  # Content-Type without Mesh-Content-Type comes from an older version, and its
+  # reply also carries Content-Type and, for a MeshError, Grpc-Status.
   class RPCService
     extend RpcDSL
 
@@ -41,10 +43,11 @@ module ProtoServiceMesh
 
     def endpoint_handler(rpc)
       lambda do |message|
+        legacy = Wire.legacy_content_type?(rpc.target, message.metadata)
         request = begin
           decode_inbound(rpc, message)
         rescue Google::Protobuf::ParseError => e
-          next status_reply(message, MeshError.new(:INTERNAL, e.message))
+          next status_reply(message, MeshError.new(:INTERNAL, e.message), legacy)
         end
 
         response = public_send(rpc.name, request)
@@ -52,17 +55,18 @@ module ProtoServiceMesh
           raise TypeError, "#{rpc.name} returned #{response.class}, expected #{rpc.output}"
         end
 
-        metadata = Wire.metadata(Wire.without_options(response.mesh_metadata).except(Wire::GRPC_STATUS_KEY))
+        metadata = Wire.metadata(Wire.without_options(response.mesh_metadata), legacy: legacy)
         ServiceMesh::Message.new(target: message.target, metadata: metadata, payload: response.to_proto)
       rescue MeshError => e
-        status_reply(message, e)
+        status_reply(message, e, legacy)
       rescue => e
-        status_reply(message, MeshError.new(:UNKNOWN, e.message))
+        status_reply(message, MeshError.new(:UNKNOWN, e.message), legacy)
       end
     end
 
     def subscriber_handler(rpc)
       lambda do |message|
+        Wire.legacy_content_type?(rpc.target, message.metadata)
         public_send(rpc.name, decode_inbound(rpc, message))
         nil
       end
@@ -81,8 +85,9 @@ module ProtoServiceMesh
       request
     end
 
-    def status_reply(message, error)
-      ServiceMesh::Message.new(target: message.target, metadata: Wire.status_metadata(error, Wire.without_options(error.mesh_metadata)), payload: error.proto.to_proto)
+    def status_reply(message, error, legacy)
+      metadata = Wire.status_metadata(error, Wire.without_options(error.mesh_metadata), legacy: legacy)
+      ServiceMesh::Message.new(target: message.target, metadata: metadata, payload: error.proto.to_proto)
     end
   end
 end

data/lib/proto_service_mesh/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProtoServiceMesh
-  VERSION = "0.18.0"
+  VERSION = "0.19.0"
 end

data/lib/proto_service_mesh/wire.rb

@@ -10,14 +10,56 @@ module ProtoServiceMesh
 
   # Metadata keys and values the specification fixes on every message.
   module Wire
-    CONTENT_TYPE_KEY = "Content-Type"
+    MESH_CONTENT_TYPE_KEY = "Mesh-Content-Type"
     CONTENT_TYPE = "application/x-protobuf"
+    MESH_STATUS_KEY = "Mesh-Status"
+
+    # Deprecated. The key older versions send in place of
+    # MESH_CONTENT_TYPE_KEY.
+    CONTENT_TYPE_KEY = "Content-Type"
+
+    # Deprecated. The key older versions send in place of MESH_STATUS_KEY.
     GRPC_STATUS_KEY = "Grpc-Status"
 
-    # Metadata for a message carrying a payload of the method's type.
-    def self.metadata(extra = {})
-      extra.to_h.merge(CONTENT_TYPE_KEY => CONTENT_TYPE)
+    # The keys the library sets itself. Values for them in application
+    # metadata are dropped.
+    KEYS = [MESH_CONTENT_TYPE_KEY, MESH_STATUS_KEY, CONTENT_TYPE_KEY, GRPC_STATUS_KEY].freeze
+
+    @warned = {}
+    @warned_lock = Mutex.new
+
+    # Metadata for a message carrying a payload of the method's type: +extra+
+    # without KEYS, with MESH_CONTENT_TYPE_KEY, and with CONTENT_TYPE_KEY
+    # too when +legacy+ is true.
+    def self.metadata(extra = {}, legacy: false)
+      out = extra.to_h.except(*KEYS).merge(MESH_CONTENT_TYPE_KEY => CONTENT_TYPE)
+      out[CONTENT_TYPE_KEY] = CONTENT_TYPE if legacy
+      out
+    end
+
+    # Whether +metadata+ comes from an older version: it carries
+    # CONTENT_TYPE_KEY and no MESH_CONTENT_TYPE_KEY. The first such message on
+    # +target+ writes a warning.
+    def self.legacy_content_type?(target, metadata)
+      deprecated?(target, metadata, CONTENT_TYPE_KEY, MESH_CONTENT_TYPE_KEY)
+    end
+
+    # Whether reply +metadata+ carries GRPC_STATUS_KEY and no
+    # MESH_STATUS_KEY. The first such reply on +target+ writes a warning.
+    def self.legacy_status?(target, metadata)
+      deprecated?(target, metadata, GRPC_STATUS_KEY, MESH_STATUS_KEY)
+    end
+
+    def self.deprecated?(target, metadata, old, replacement)
+      return false unless metadata.key?(old) && !metadata.key?(replacement)
+
+      first = @warned_lock.synchronize { @warned.key?([old, target.segments]) ? false : @warned[[old, target.segments]] = true }
+      if first
+        warn "proto_service_mesh: a message on #{target.segments.inspect} carries the deprecated metadata key #{old} in place of #{replacement}; the sender runs an older version"
+      end
+      true
     end
+    private_class_method :deprecated?
 
     # Splits +metadata+ into the message metadata and the transport options:
     # the keys that start with OPTION_PREFIX become options with the prefix
@@ -40,9 +82,13 @@ module ProtoServiceMesh
       split_options(metadata).first
     end
 
-    # Metadata for a reply whose payload is an encoded google.rpc.Status.
-    def self.status_metadata(error, extra = {})
-      extra.to_h.merge(CONTENT_TYPE_KEY => CONTENT_TYPE, GRPC_STATUS_KEY => error.proto.code.to_s)
+    # Metadata for a reply whose payload is an encoded google.rpc.Status:
+    # metadata(extra, legacy:) with MESH_STATUS_KEY, and with GRPC_STATUS_KEY
+    # too when +legacy+ is true.
+    def self.status_metadata(error, extra = {}, legacy: false)
+      out = metadata(extra, legacy: legacy).merge(MESH_STATUS_KEY => error.proto.code.to_s)
+      out[GRPC_STATUS_KEY] = out[MESH_STATUS_KEY] if legacy
+      out
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: proto_service_mesh
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Bryant Morrill