mfp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3525ca738b1b2808085c13bc5695f1c5828a15997dec33262b7d3ae70f327a22
+  data.tar.gz: 70b05bc2f1dcf64fb5dd1ccc504f0e48ab5f41f1dfe1eeff2db15cc147712284
+SHA512:
+  metadata.gz: 90a6de0a911c51be9e2c8786109f3670b630c4a1c8f159a0e6d3de5e31ea76d1979ef809d94cae30731244a8b7969c885991c34fa4685513a17731e1e9fafe82
+  data.tar.gz: 17ddea6ff55b8c351be36918935e4f7ae15c8a86756d1836c0dc06272b62e72ba209f91562ddb4b93e90b9214b7c38e1bd458189c2cb53013fd67ed7880b2978

data/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.rb]
+charset = utf-8
+indent_style = space
+indent_size = 2

data/.ruby-version

@@ -0,0 +1 @@
+ruby-4.0.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"mfp" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["hey@vito.io"](mailto:"hey@vito.io").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Vito Sartori
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Mfp
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mfp`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mfp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/mfp/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mfp project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mfp/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/mfp/client.rb

@@ -0,0 +1,390 @@
+# frozen_string_literal: true
+
+module Mfp
+  class Client
+    Settings = Data.define(
+      :ca_certs,
+      :key,
+      :cert,
+      :insecure,
+      :application,
+      :hostname,
+      :disable_compression,
+      :idle_timeout_secs,
+      :ping_timeout_secs,
+      :logger,
+    )
+
+    DEFAULT_OPTS = {
+      ca_certs: [],
+      key: nil,
+      cert: nil,
+      insecure: false,
+      application: nil,
+      hostname: Socket.gethostname,
+      disable_compression: false,
+      idle_timeout_secs: 30,
+      ping_timeout_secs: 10,
+      logger: Logrb.noop,
+    }.freeze
+
+    attr_reader :max_streams, :max_payload
+
+    def initialize(host, port, call_sign, **)
+      raise InvalidCallSignLengthError, "call_sign must have 4 bytes" if call_sign.bytesize != 4
+
+      # State
+
+      @running = true
+      @to_write = Async::Queue.new
+      @to_read = Async::Queue.new
+      @call_sign = call_sign
+      @max_streams = nil
+      # this is set initially to zero so we can transmit the HELLO payload.
+      # Once the handshake is completed, this value will be replaced with
+      # whatever the server returns to us.
+      @max_payload = 0
+      @inner_tasks = []
+
+      # Networking
+
+      @host = host
+      @port = port
+      @settings = Settings.new(**DEFAULT_OPTS.dup, **)
+
+      @logger = @settings.logger
+
+      @endpoint = if (@settings.cert && @settings.key) || !@settings.ca_certs.empty? || @settings.insecure
+        @logger.debug("Starting TLS client", hostname: host, port:)
+        ctx = Mfp.default_tls_context
+        ctx.cert = OpenSSL::X509::Certificate.new(@settings.cert) if @settings.cert
+        ctx.key = OpenSSL::PKey.read(@settings.key) if @settings.key
+        ctx.verify_mode = @settings.insecure ? OpenSSL::SSL::VERIFY_NONE : OpenSSL::SSL::VERIFY_PEER
+        store = OpenSSL::X509::Store.new
+        store.set_default_paths
+        @settings.ca_certs.each do |raw|
+          store.add_cert(OpenSSL::X509::Certificate.new(raw))
+        end
+        ctx.cert_store = store
+        IO::Endpoint.ssl(host, port, ssl_context: ctx)
+      else
+        @logger.debug("Starting plain client", hostname: host, port:)
+        IO::Endpoint.tcp(host, port)
+      end
+
+      @compressor = Compressor.new(:identity)
+      @ping_handler = PingHandler.new(
+        idle_timeout: @settings.idle_timeout_secs,
+        ping_timeout: @settings.ping_timeout_secs,
+      )
+    end
+
+    def start(task)
+      @task = task.async do |t|
+        @socket = @endpoint.connect
+        @inner_tasks << t.async { handle_writes }
+        setup
+      end
+
+      begin
+        @task.wait
+      rescue StandardError => e
+        stop_inner_tasks!
+        raise Mfp::Error, "handshake failed: #{e.message}"
+      end
+
+      @inner_tasks << task.async { handle_reads }
+      @inner_tasks << task.async { @ping_handler.start(it) }
+      @inner_tasks << task.async { handle_pings }
+    end
+
+    def close
+      return unless @running
+
+      abort!(reason: CONNECTION_EVENT_CODE_DISCONNECTED)
+      nil
+    end
+
+    def recv = @to_read.dequeue
+
+    def send_stream(id, msg, flags: 0)
+      send(Proto::Frame.new(
+        stream_id: id,
+        kind: Proto::MessageKind::STREAM,
+        flags:,
+        payload: msg,
+        length: msg&.bytesize || 0,
+      ))
+    end
+
+    def send_control(id, msg, flags: 0)
+      send(Proto::Frame.new(
+        stream_id: id,
+        kind: Proto::MessageKind::CONTROL,
+        flags:,
+        payload: msg,
+        length: msg&.bytesize || 0,
+      ))
+    end
+
+    private
+
+    def terminate_error(code)
+      send(Proto::Error.new(code, terminal: true).encode(0))
+    rescue StandardError
+      # noop
+    ensure
+      abort!(reason: CONNECTION_EVENT_CODE_BROKEN)
+    end
+
+    def send(frame)
+      size = frame.payload&.bytesize || 0
+      raise PayloadMustBeLessThan4GBError if size >= 0xFFFFFFFF
+      raise PayloadTooLargeError if !@max_payload.zero? && size > @max_payload
+      raise ClientClosedError unless @running
+
+      out = OutgoingMessage.new(frame)
+      @logger.debug("Send frame", frame: frame.inspect)
+      err = Async::Task.current.defer_cancel do
+        @to_write.enqueue out
+        out.wait
+      end
+      raise err if err
+    end
+
+    def setup
+      caps = 0
+      unless @settings.disable_compression
+        caps |= Proto::Capability::COMPRESSION_BROTLI
+        caps |= Proto::Capability::COMPRESSION_GZIP
+      end
+      hello = Proto::Hello.new(
+        version_major: 1,
+        version_minor: 0,
+        capabilities: caps,
+        application: @settings.application,
+        host: @settings.hostname,
+      )
+      fr = hello.encode(0)
+
+      send(fr)
+      fr = read_frame(1 << 20)
+
+      case fr.kind
+      when Proto::MessageKind::HELLO_RESPONSE
+        resp = Proto::HelloResponse.read(fr)
+        if resp.capabilities == Proto::Capability::COMPRESSION_BROTLI
+          @compressor = Compressor.new(:brotli)
+        elsif resp.capabilities == Proto::Capability::COMPRESSION_GZIP
+          @compressor = Compressor.new(:gzip)
+        end
+        @max_payload = resp.max_payload || 0
+        @max_streams = resp.max_streams || 0
+
+      when Proto::MessageKind::ERROR
+        msg = Proto::Error.read(fr)
+        debug = ""
+        debug = ", debug: #{Base64.encode64(msg.debug)}" unless msg.debug.nil?
+        raise Mfp::Error, "Error returned from server: #{msg.code}#{debug}"
+
+      else
+        raise Mfp::Error, "Unexpected message kind after HELLO"
+
+      end
+    end
+
+    def handle_writes
+      while @running
+        out = @to_write.dequeue
+        return if out.nil?
+
+        unless @running
+          out.complete(ClientClosedError.new)
+          drain_writes_closing
+          return
+        end
+
+        fr = out.frame
+        fr.call_sign = @call_sign
+        size = fr.payload&.bytesize || 0
+        if !size.zero? && fr.kind == Proto::MessageKind::STREAM && @compressor.kind != :identity
+          buf = @compressor.compress(fr.payload)
+          fr.length = buf.bytesize
+          fr.payload = buf
+        else
+          fr.length = size
+        end
+
+        msg = fr.encode
+
+        begin
+          @socket.write(msg)
+        rescue StandardError => e
+          out.complete(e)
+          next
+        end
+
+        out.complete(nil)
+      end
+    end
+
+    def handle_reads
+      while @running
+        fr = nil
+        begin
+          fr = read_frame
+        rescue StandardError => e
+          @logger.error("Failed reading frame", e) if @running
+          abort!(reason: CONNECTION_EVENT_CODE_BROKEN)
+          return
+        end
+
+        @ping_handler.notify_received
+
+        case fr.kind
+        when Proto::MessageKind::ERROR
+          begin
+            err = Proto::Error.read(fr)
+          rescue StandardError => e
+            @logger.error("Failed parsing error message", e)
+            abort!(reason: CONNECTION_EVENT_CODE_BROKEN)
+            return
+          end
+
+          ev = ErrorEvent.new(
+            stream_id: fr.stream_id,
+            code: err.code,
+            terminal: err.terminal,
+            debug: err.debug,
+          )
+          @to_read.enqueue(ev) if @running
+
+        when Proto::MessageKind::STREAM
+          if @compressor.kind != :identity && fr.length.positive?
+            begin
+              payload = @compressor.decompress(fr.payload)
+              fr.payload = payload
+            rescue StandardError => e
+              @logger.error("Failed decompressing message", e)
+              terminate_error(Proto::ErrorKind::COMPRESSION_ERROR)
+              return
+            end
+          end
+
+          ev = StreamEvent.new(
+            stream_id: fr.stream_id,
+            payload: fr.payload,
+          )
+          @to_read.enqueue(ev) if @running
+
+        when Proto::MessageKind::CONTROL
+          ev = ControlEvent.new(
+            stream_id: fr.stream_id,
+            payload: fr.payload,
+          )
+          @to_read.enqueue(ev) if @running
+
+        when Proto::MessageKind::PING
+          unless fr.stream_id.zero?
+            terminate_error(Proto::ErrorKind::PROTOCOL_ERROR)
+            return
+          end
+
+          if fr.length != 8
+            terminate_error(Proto::ErrorKind::FRAME_SIZE_ERROR)
+            return
+          end
+
+          begin
+            handle_ping(fr)
+          rescue StandardError
+            terminate_error(Proto::ErrorKind::INTERNAL_ERROR)
+          end
+        else
+          @logger.warn("Received unexpected message kind during runtime", kind: fr.kind)
+          abort!(reason: CONNECTION_EVENT_CODE_BROKEN)
+          return
+        end
+      end
+    end
+
+    def drain_writes_closing
+      loop do
+        out = @to_write.dequeue
+        return if out.nil?
+
+        out.complete(ClientClosedError.new)
+      end
+    end
+
+    def read_frame(max_len = 0)
+      max_len = @max_payload if max_len.zero?
+      max_len = 0 if max_len.nil?
+
+      fr = Proto::Frame.read(@socket, max_len, @call_sign)
+      @logger.debug("Read frame", frame: fr.inspect)
+      fr
+    end
+
+    def handle_ping(fr)
+      png = nil
+      begin
+        png = Proto::Ping.read(fr)
+      rescue StandardError
+        terminate_error(Proto::ErrorKind::PROTOCOL_ERROR)
+        return
+      end
+
+      if png.ack
+        @ping_handler.notify_pong(png.payload)
+        return
+      end
+
+      resp = Proto::Ping.new(ack: true, payload: png.payload)
+      send(resp.encode(0))
+    end
+
+    def handle_pings
+      while @running
+        ev = @ping_handler.recv
+        return if ev.nil?
+
+        case ev[:kind]
+        when :request
+          png = Proto::Ping.new(
+            ack: false,
+            payload: ev[:cookie],
+          )
+          begin
+            send(png.encode(0))
+          rescue StandardError => e
+            @logger.error("Failed sending ping", e)
+            abort!(reason: CONNECTION_EVENT_CODE_BROKEN)
+            return
+          end
+        when :timeout
+          @logger.warn("Timed out waiting for ping acknowledgement. Aborting connection...")
+          abort!(reason: CONNECTION_EVENT_CODE_TIMED_OUT)
+          return
+        end
+      end
+    end
+
+    def abort!(reason: nil)
+      return unless @running
+
+      @running = false
+      @ping_handler&.stop
+      @to_write.close
+      @to_read.enqueue ConnectionEvent.new(code: reason)
+      @to_read.close
+      @task&.stop
+      @socket&.close
+    end
+
+    def stop_inner_tasks!
+      @inner_tasks.each(&:stop)
+      @socket&.close
+    end
+  end
+end

data/lib/mfp/compressor.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Mfp
+  class Compressor
+    attr_reader :kind
+
+    def initialize(algo)
+      @kind = algo
+      case algo
+      when :identity
+        nil
+      when :gzip
+        @compress = Zlib.method(:gzip)
+        @decompress = Zlib.method(:gunzip)
+      when :brotli
+        @compress = Brotli.method(:deflate)
+        @decompress = Brotli.method(:inflate)
+      else
+        raise ArgumentError, "Unknown compression algorithm #{algo}"
+      end
+    end
+
+    def compress(data)
+      return data unless @compress
+
+      @compress.call(data)
+    end
+
+    def decompress(data)
+      return data unless @decompress
+
+      @decompress.call(data)
+    end
+  end
+end

data/lib/mfp/enum.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Mfp
+  class Enum
+    class Value
+      include Comparable
+
+      attr_reader :name, :value
+
+      def initialize(owner, name, value)
+        @owner = owner
+        @name  = name.to_sym
+        @value = Integer(value)
+        freeze
+      end
+
+      # implicit integer coercion
+      def to_int      = @value
+      def to_i        = @value
+      def to_s        = @value.to_s
+      def to_json(*_a) = @value.to_json
+
+      # ==, case/when, hashing, ordering
+      def ==(other)  = @value == coerced(other)
+      def ===(other) = @value == coerced(other)
+      alias eql? ==
+      def hash = @value.hash
+
+      def <=>(other)
+        c = coerced(other)
+        c.nil? ? nil : @value <=> c
+      end
+
+      # arithmetic when the Value is on the right
+      def coerce(other) = [other, @value]
+
+      # everything else Integer can do
+      def method_missing(name, *, &)
+        @value.respond_to?(name) ? @value.public_send(name, *, &) : super
+      end
+
+      def respond_to_missing?(name, include_private = false)
+        @value.respond_to?(name, include_private) || super
+      end
+
+      def inspect = @name.to_s
+
+      private
+
+      def coerced(other)
+        return other.value if other.is_a?(Value)
+        return other if other.is_a?(Integer)
+
+        other.to_int if other.respond_to?(:to_int)
+      end
+    end
+
+    class << self
+      include Enumerable
+
+      def define(name, value)
+        name = name.to_sym
+        raise ArgumentError, "#{name} already defined on #{self}" if const_defined?(name, false)
+
+        instance = Value.new(self, name, value)
+        const_set(name, instance)
+        registry[name] = instance
+        instance
+      end
+
+      def [](value)   = registry.values.find { |v| v.value == value }
+      def named(name) = registry[name.to_sym]
+      def values      = registry.values
+      def names       = registry.keys
+      def each(&) = values.each(&)
+      def max = values.max
+
+      private
+
+      def registry = (@registry ||= {})
+    end
+  end
+end

data/lib/mfp/error.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Mfp
+  class Error < StandardError; end
+  class PayloadTooLargeError < Error; end
+  class ClientClosedError < Error; end
+  class ConnectionClosedError < Error; end
+  class InvalidCallSignLengthError < Error; end
+  class PayloadMustBeLessThan4GBError < Error; end
+  class InvalidCallSignError < Error; end
+
+  class ParserError < Error
+    attr_reader :error_code
+
+    def initialize(value)
+      @error_code = value
+      super(value.inspect)
+    end
+  end
+end

data/lib/mfp/event.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mfp
+  # StreamEvent is delivered when a STREAM frame is received on a connection.
+  # Payload contains the raw frame payload, already decompressed if compression
+  # was negotiated. StreamID is always non-zero.
+  StreamEvent = Data.define(:stream_id, :payload)
+
+  # ControlEvent is delivered when a CONTROL frame is received on a connection.
+  # Payload is opaque to MFP — its structure is defined by the upper-layer
+  # protocol. StreamID may be zero for connection-scoped signals.
+  ControlEvent = Data.define(:stream_id, :payload)
+
+  # ErrorEvent is delivered when a stream-level ERROR frame is received.
+  # Connection-level errors are handled internally by MFP and never forwarded.
+  # Terminal indicates whether the stream has been terminated by this error.
+  ErrorEvent = Data.define(:stream_id, :code, :terminal, :debug)
+
+  ConnectionEvent = Data.define(:code)
+
+  CONNECTION_EVENT_CODE_INVALID = 0
+  CONNECTION_EVENT_CODE_DISCONNECTED = 1
+  CONNECTION_EVENT_CODE_BROKEN = 2
+  CONNECTION_EVENT_CODE_TIMED_OUT = 3
+end

data/lib/mfp/outgoing_message.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Mfp
+  class OutgoingMessage
+    attr_reader :frame
+
+    def initialize(frame)
+      @frame = frame
+      @result = Async::Queue.new
+    end
+
+    def wait = @result.dequeue
+    def complete(error) = @result.enqueue(error)
+  end
+end