Module: HTTPX::Plugins::GRPC::InstanceMethods

Defined in:
lib/httpx/plugins/grpc.rb,
sig/plugins/grpc.rbs

Instance Method Summary collapse

Instance Method Details

#build_grpc_request(rpc_method, input, deadline:, metadata: nil, **opts) ⇒ Request

Parameters:

  • rpc_method (string)
  • input (grpc_message)
  • deadline: (Integer)
  • headers_input (metadata?:)
  • (Object)

Returns:



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/httpx/plugins/grpc.rb', line 252

def build_grpc_request(rpc_method, input, deadline:, metadata: nil, **opts)
  uri = @options.origin.dup
  rpc_method = "/#{rpc_method}" unless rpc_method.start_with?("/")
  rpc_method = "/#{@options.grpc_service}#{rpc_method}" if @options.grpc_service
  uri.path = rpc_method

  headers = HEADERS.merge(
    "grpc-accept-encoding" => ["identity", *@options.supported_compression_formats]
  )
  unless deadline == Float::INFINITY
    # convert to milliseconds
    deadline = (deadline * 1000.0).to_i
    headers["grpc-timeout"] = "#{deadline}m"
  end

  headers = headers.merge(metadata.transform_keys(&:to_s)) if metadata

  # prepare compressor
  compression = @options.grpc_compression == true ? "gzip" : @options.grpc_compression

  headers["grpc-encoding"] = compression if compression

  headers.merge!(@options.call_credentials.call.transform_keys(&:to_s)) if @options.call_credentials

  build_request("POST", uri, headers: headers, body: input, **opts)
end

#build_stub(origin, service: nil, compression: false) ⇒ instance

Parameters:

  • origin (string)
  • service: (_ToS) (defaults to: nil)
  • compression: (compression_option) (defaults to: false)

Returns:

  • (instance) 


182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/httpx/plugins/grpc.rb', line 182

def build_stub(origin, service: nil, compression: false)
  scheme = @options.ssl.empty? ? "http" : "https"

  origin = URI.parse("#{scheme}://#{origin}")

  session = self

  if service && service.respond_to?(:rpc_descs)
    # it's a grpc generic service
    service.rpc_descs.each do |rpc_name, rpc_desc|
      rpc_opts = {
        marshal_method: rpc_desc.marshal_method,
        unmarshal_method: rpc_desc.unmarshal_method,
      }

      input = rpc_desc.input
      input = input.type if input.respond_to?(:type)

      output = rpc_desc.output
      if output.respond_to?(:type)
        rpc_opts[:stream] = true
        output = output.type
      end

      session = session.rpc(rpc_name, input, output, **rpc_opts)
    end

    service = service.service_name
  end

  session.with(origin: origin, grpc_service: service, grpc_compression: compression)
end

#execute(rpc_method, input, deadline: DEADLINE, metadata: nil, **opts) ⇒ Call

Parameters:

  • rpc_method (_ToS)
  • input (grpc_message)
  • deadline: (Integer) (defaults to: DEADLINE)
  • metadata: (headers_input) (defaults to: nil)
  • (Object)

Returns:



215
216
217
218
219
220
221
222
223
 
# File 'lib/httpx/plugins/grpc.rb', line 215

def execute(rpc_method, input,
            deadline: DEADLINE,
            metadata: nil,
            **opts)
  grpc_request = build_grpc_request(rpc_method, input, deadline: deadline, metadata: metadata, **opts)
  response = request(grpc_request, **opts)
  response.raise_for_status unless opts[:stream]
  GRPC::Call.new(response)
end

#rpc(rpc_name, input, output, **opts) ⇒ instance

Parameters:

  • rpc_name (_ToS)
  • input (Object)
  • output (Object)
  • (Object)

Returns:

  • (instance)

Raises:



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/httpx/plugins/grpc.rb', line 147

def rpc(rpc_name, input, output, **opts)
  rpc_name = rpc_name.to_s
  raise Error, "rpc #{rpc_name} already defined" if @options.grpc_rpcs.key?(rpc_name)

  rpc_opts = {
    deadline: @options.grpc_deadline,
  }.merge(opts)

  local_rpc_name = rpc_name.underscore

  session_class = Class.new(self.class) do
    # define rpc method with ruby style name
    class_eval(<<-OUT, __FILE__, __LINE__ + 1)
      def #{local_rpc_name}(input, **opts)              # def grpc_action(input, **opts)
        rpc_execute("#{local_rpc_name}", input, **opts) #   rpc_execute("grpc_action", input, **opts)
      end                                               # end
    OUT

    # define rpc method with original name
    unless local_rpc_name == rpc_name
      class_eval(<<-OUT, __FILE__, __LINE__ + 1)
        def #{rpc_name}(input, **opts)                    # def grpcAction(input, **opts)
          rpc_execute("#{local_rpc_name}", input, **opts) #   rpc_execute("grpc_action", input, **opts)
        end                                               # end
      OUT
    end
  end

  session_class.new(@options.merge(
                      grpc_rpcs: @options.grpc_rpcs.merge(
                        local_rpc_name => [rpc_name, input, output, rpc_opts]
                      ).freeze
                    ))
end

#rpc_execute(rpc_name, input, **opts) ⇒ Call

Parameters:

  • rpc_method (_ToS)
  • input (grpc_request)
  • (Object)

Returns:



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/httpx/plugins/grpc.rb', line 227

def rpc_execute(rpc_name, input, **opts)
  rpc_name, input_enc, output_enc, rpc_opts = @options.grpc_rpcs[rpc_name]

  exec_opts = rpc_opts.merge(opts)

  marshal_method ||= exec_opts.delete(:marshal_method) || MARSHAL_METHOD
  unmarshal_method ||= exec_opts.delete(:unmarshal_method) || UNMARSHAL_METHOD

  messages = if input.respond_to?(:each)
    Enumerator.new do |y|
      input.each do |message|
        y << input_enc.__send__(marshal_method, message)
      end
    end
  else
    input_enc.__send__(marshal_method, input)
  end

  call = execute(rpc_name, messages, **exec_opts)

  call.decoder = output_enc.method(unmarshal_method)

  call
end

#with_channel_credentials(ca_path, key = nil, cert = nil, **ssl_opts) ⇒ instance

Parameters:

  • ca_path (String)
  • key (String, nil) (defaults to: nil)
  • cert (String, nil) (defaults to: nil)
  • (Object)

Returns:

  • (instance) 


128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/httpx/plugins/grpc.rb', line 128

def with_channel_credentials(ca_path, key = nil, cert = nil, **ssl_opts)
  # @type var ssl_params: ::Hash[::Symbol, untyped]
  ssl_params = {
    **ssl_opts,
    ca_file: ca_path,
  }
  if key
    key = File.read(key) if File.file?(key)
    ssl_params[:key] = OpenSSL::PKey.read(key)
  end

  if cert
    cert = File.read(cert) if File.file?(cert)
    ssl_params[:cert] = OpenSSL::X509::Certificate.new(cert)
  end

  with(ssl: ssl_params)
end